Tayfunwiki: Created page with "== `SistersInLaw` Method in Actor Class == === Overview === The `SistersInLaw` method in the `Actor` class is intended to retrieve the sisters-in-law of an actor. This method provides the option to include both living and deceased sisters-in-law based on the provided parameter. === Syntax === public IEnumerable SistersInLaw(bool inclusivePassive = true) === Parameters === * `i..."`


2023-12-21T18:55:04Z
Created page with "== <code>SistersInLaw</code> Method in Actor Class ==  === Overview === The <code>SistersInLaw</code> method in the <code>Actor</code> class is intended to retrieve the sisters-in-law of an actor. This method provides the option to include both living and deceased sisters-in-law based on the provided parameter.  === Syntax === <syntaxhighlight lang="c#"> public IEnumerable<Actor> SistersInLaw(bool inclusivePassive = true) </syntaxhighlight>  === Parameters ===  * <code>i..."
New page
== <code>SistersInLaw</code> Method in Actor Class ==



=== Overview ===

The <code>SistersInLaw</code> method in the <code>Actor</code> class is intended to retrieve the sisters-in-law of an actor. This method provides the option to include both living and deceased sisters-in-law based on the provided parameter.



=== Syntax ===

<syntaxhighlight lang="c#">

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

</syntaxhighlight>



=== Parameters ===



* <code>inclusivePassive</code> (bool): A flag that indicates whether deceased (passive state) sisters-in-law should be included in the returned collection. The default setting is <code>true</code>.



=== Returns ===



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

* When <code>inclusivePassive</code> is set to <code>true</code>, the collection includes all sisters-in-law, regardless of their living status.

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



=== Description ===

The <code>SistersInLaw</code> method facilitates access to the actor's sisters-in-law, allowing for the inclusion of deceased sisters-in-law based on the <code>inclusivePassive</code> parameter. This method is particularly useful in games where extended family relationships are significant.



=== Usage ===

This method can be important in game narratives or mechanics where an actor's relationship with their extended family, including sisters-in-law, is relevant. This could involve storylines about marital family relations, inheritance issues, or familial alliances and conflicts.



==== Example: ====

<syntaxhighlight lang="c#">

var allSistersInLaw = someActor.SistersInLaw();

var livingSistersInLaw = someActor.SistersInLaw(false);

</syntaxhighlight>In these examples, <code>allSistersInLaw</code> includes both living and deceased sisters-in-law, while <code>livingSistersInLaw</code> includes only the living ones.



=== Remarks ===



* The option to include or exclude deceased sisters-in-law provides a complete view of the actor's extended family.

* This functionality is crucial for accurately portraying complex family trees and their impact on the game's narrative and character dynamics.

* The <code>SistersInLaw</code> method adds depth to the game's world, allowing for richer and more nuanced storytelling.

SistersInLaw - Revision history