Family.OnMemberJoin - Revision history

Tayfunwiki: Created page with "== `onMemberJoin` Event in Family Class == === Overview === The `onMemberJoin` event in the Family class is triggered when a new member joins the family. This event is particularly relevant in games where family dynamics, lineage, and relationships play a significant role in the gameplay and narrative. === Event Definition === public Action onMemberJoin; === Description === * Event Type:
2024-01-05T02:43:08Z

Created page with "== <code>onMemberJoin</code> Event in Family Class == === Overview === The <code>onMemberJoin</code> event in the Family class is triggered when a new member joins the family. This event is particularly relevant in games where family dynamics, lineage, and relationships play a significant role in the gameplay and narrative. === Event Definition === <syntaxhighlight lang="c#"> public Action<Actor> onMemberJoin; </syntaxhighlight> === Description === * Event Type: <cod..."

New page
== <code>onMemberJoin</code> Event in Family Class ==

=== Overview ===
The <code>onMemberJoin</code> event in the Family class is triggered when a new member joins the family. This event is particularly relevant in games where family dynamics, lineage, and relationships play a significant role in the gameplay and narrative.

=== Event Definition ===
<syntaxhighlight lang="c#">
public Action<Actor> onMemberJoin;
</syntaxhighlight>

=== Description ===

* Event Type: <code>Action<Actor></code>
* Functionality: Notifies when a new member joins the family, providing the <code>Actor</code> object representing the new member.

=== Usage ===
The event can be used for updating family trees, modifying family-based quests, or triggering specific storylines or dialogues in response to the addition of a new family member.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class FamilyMemberAdditionListener : MonoBehaviour {
void Start() {
Family playerFamily = IM.Player.Family;
if (playerFamily != null) {
playerFamily.onMemberJoin += HandleNewFamilyMember;
}
}

private void HandleNewFamilyMember(Actor newMember) {
Debug.Log($"A new member, {newMember.Name}, has joined the player's family.");
// Additional logic for handling the new family member
}

void OnDestroy() {
if (IM.Player.Family != null) {
IM.Player.Family.onMemberJoin -= HandleNewFamilyMember;
}
}
}
</syntaxhighlight>

==== Description ====

* This example demonstrates how to subscribe to the <code>onMemberJoin</code> event and handle it.
* When a new member joins the player's family, <code>HandleNewFamilyMember</code> is called, logging the name of the new member and possibly triggering additional actions or updates.

=== Remarks ===

* It's important to unsubscribe from the event in the <code>OnDestroy</code> method to prevent memory leaks or unintended behavior.
* The <code>onMemberJoin</code> event helps in maintaining an up-to-date and dynamic representation of the player's family, adapting to changes in family composition.