Tayfunwiki: Created page with "== `Children` Method in Actor Class == === Overview === The `Children` method in the `Actor` class is designed to retrieve the children of an actor. It offers the flexibility to include or exclude deceased children based on a specified parameter. === Syntax === public IEnumerable Children(bool inclusivePassive = true) === Parameters === * `inclusivePassive` (bool): A boo..."

2023-12-21T16:52:54Z

Created page with "== <code>Children</code> Method in Actor Class == === Overview === The <code>Children</code> method in the <code>Actor</code> class is designed to retrieve the children of an actor. It offers the flexibility to include or exclude deceased children based on a specified parameter. === Syntax === <syntaxhighlight lang="c#"> public IEnumerable<Actor> Children(bool inclusivePassive = true) </syntaxhighlight> === Parameters === * <code>inclusivePassive</code> (bool): A boo..."

New page

== <code>Children</code> Method in Actor Class ==

=== Overview ===
The <code>Children</code> method in the <code>Actor</code> class is designed to retrieve the children of an actor. It offers the flexibility to include or exclude deceased children based on a specified parameter.

=== Syntax ===
<syntaxhighlight lang="c#">
public IEnumerable<Actor> Children(bool inclusivePassive = true)
</syntaxhighlight>

=== Parameters ===

* <code>inclusivePassive</code> (bool): A boolean flag that determines whether deceased (passive state) children should be included in the returned collection. It defaults to <code>true</code>.

=== Returns ===

* Return Type: <code>IEnumerable<Actor></code>. This method returns a collection of <code>Actor</code> objects representing the children of the actor.
* If <code>inclusivePassive</code> is <code>true</code>, both living and deceased children are included.
* If <code>inclusivePassive</code> is <code>false</code>, only living (active state) children are included.

=== Description ===
The <code>Children</code> method is essential for accessing the children of an actor, with an option to consider the state (alive or dead) of these children. The inclusion of deceased children is controlled by the <code>inclusivePassive</code> parameter.

=== Usage ===
This method is useful in game mechanics or narratives where an actor's relationship with their children, including those who may have passed away, is important.

==== Example: ====
<syntaxhighlight lang="c#">
var allChildren = someActor.Children();
var livingChildren = someActor.Children(false);
</syntaxhighlight>In the first example, <code>allChildren</code> will contain all the children of the actor, regardless of their state. In the second example, <code>livingChildren</code> will only include the living children of the actor.

=== Remarks ===

* This flexibility in handling children based on their state allows for nuanced storytelling and gameplay, especially in scenarios involving family dynamics and inheritance.
* The <code>Children</code> method plays a vital role in managing familial relationships and lineage within the game.

Children - Revision history