Tayfunwiki at 18:43, 21 December 2023

2023-12-21T18:43:53Z

← Older revision		Revision as of 14:43, 21 December 2023
Line 27:		Line 27:
	==== Example: ====		==== Example: ====
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	~~IEnumerable<Actor>~~ allGrandchildren = someActor.Grandchildren();		var allGrandchildren = someActor.Grandchildren();
	~~IEnumerable<Actor>~~ livingGrandchildren = someActor.Grandchildren(false);		var livingGrandchildren = someActor.Grandchildren(false);
	</syntaxhighlight>In the first example, <code>allGrandchildren</code> includes both living and deceased grandchildren, while <code>livingGrandchildren</code> includes only the living ones.		</syntaxhighlight>In the first example, <code>allGrandchildren</code> includes both living and deceased grandchildren, while <code>livingGrandchildren</code> includes only the living ones.

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


2023-12-21T18:42:04Z
Created page with "== <code>Grandchildren</code> Method in Actor Class ==  === Overview === The <code>Grandchildren</code> method in the <code>Actor</code> class is designed to retrieve the grandchildren of an actor. It offers the option to include or exclude deceased grandchildren based on a specified parameter.  === Syntax === <syntaxhighlight lang="c#"> public IEnumerable<Actor> Grandchildren(bool inclusivePassive = true) </syntaxhighlight>  === Parameters ===  * <code>inclusivePassive<..."
New page
== <code>Grandchildren</code> Method in Actor Class ==



=== Overview ===

The <code>Grandchildren</code> method in the <code>Actor</code> class is designed to retrieve the grandchildren of an actor. It offers the option to include or exclude deceased grandchildren based on a specified parameter.



=== Syntax ===

<syntaxhighlight lang="c#">

public IEnumerable<Actor> Grandchildren(bool inclusivePassive = true)

</syntaxhighlight>



=== Parameters ===



* <code>inclusivePassive</code> (bool): A flag that indicates whether to include deceased (passive state) grandchildren in the returned collection. The default value is <code>true</code>.



=== Returns ===



* Return Type: <code>IEnumerable<Actor></code>. This method returns a collection of <code>Actor</code> objects, each representing a grandchild of the actor.

* When <code>inclusivePassive</code> is set to <code>true</code>, the collection includes all grandchildren, regardless of their state (alive or dead).

* When <code>inclusivePassive</code> is set to <code>false</code>, it only includes living (active state) grandchildren.



=== Description ===

The <code>Grandchildren</code> method provides a means to access the actor's grandchildren, allowing for inclusion of those who have passed away, depending on the <code>inclusivePassive</code> parameter. The method uses LINQ's <code>SelectMany</code> function to collate grandchildren from the actor's children, ensuring a comprehensive collection.



=== Usage ===

This method is particularly useful in game mechanics or narratives where an actor's relationship with their grandchildren, including those who may have passed away, is significant.



==== Example: ====

<syntaxhighlight lang="c#">

IEnumerable<Actor> allGrandchildren = someActor.Grandchildren();

IEnumerable<Actor> livingGrandchildren = someActor.Grandchildren(false);

</syntaxhighlight>In the first example, <code>allGrandchildren</code> includes both living and deceased grandchildren, while <code>livingGrandchildren</code> includes only the living ones.



=== Remarks ===



* The ability to include or exclude deceased grandchildren provides depth to the handling of familial and relational dynamics within the game.

* The <code>Grandchildren</code> method is crucial for managing complex relationships and can significantly impact the storylines and character interactions in the game.

Grandchildren - Revision history

Tayfunwiki at 18:43, 21 December 2023