SistersInLaw

From Intrigues Wiki
Revision as of 13:55, 21 December 2023 by Tayfunwiki (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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<Actor> SistersInLaw(bool inclusivePassive = true)

Parameters

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

Returns

  • Return Type: IEnumerable<Actor>. This method returns a collection of Actor objects, each representing a sister-in-law of the actor.
  • When inclusivePassive is set to true, the collection includes all sisters-in-law, regardless of their living status.
  • When inclusivePassive is set to false, it includes only living (active state) sisters-in-law.

Description

The SistersInLaw method facilitates access to the actor's sisters-in-law, allowing for the inclusion of deceased sisters-in-law based on the inclusivePassive 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:

var allSistersInLaw = someActor.SistersInLaw();
var livingSistersInLaw = someActor.SistersInLaw(false);

In these examples, allSistersInLaw includes both living and deceased sisters-in-law, while livingSistersInLaw 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 SistersInLaw method adds depth to the game's world, allowing for richer and more nuanced storytelling.