Tayfunwiki: Created page with "== `GetMember` Method in Clan Class == === Overview === The `GetMember` method in the Clan class is designed to retrieve a specific member of the clan based on their role. This method is useful for identifying individual clan members who fulfill particular roles within the clan's structure. === Method Definition === public Actor GetMember(string roleFilter, bool inclusivePassive = false); === Descrip..."

2024-01-05T00:49:08Z

Created page with "== <code>GetMember</code> Method in Clan Class == === Overview === The <code>GetMember</code> method in the Clan class is designed to retrieve a specific member of the clan based on their role. This method is useful for identifying individual clan members who fulfill particular roles within the clan's structure. === Method Definition === <syntaxhighlight lang="c#"> public Actor GetMember(string roleFilter, bool inclusivePassive = false); </syntaxhighlight> === Descrip..."

New page

== <code>GetMember</code> Method in Clan Class ==

=== Overview ===
The <code>GetMember</code> method in the Clan class is designed to retrieve a specific member of the clan based on their role. This method is useful for identifying individual clan members who fulfill particular roles within the clan's structure.

=== Method Definition ===
<syntaxhighlight lang="c#">
public Actor GetMember(string roleFilter, bool inclusivePassive = false);
</syntaxhighlight>

=== Description ===

* Parameters:
** <code>roleFilter</code>: A string representing the role to filter the member by (e.g., 'Engineer').
** <code>inclusivePassive</code>: A boolean flag. If set to <code>true</code>, includes passive (e.g., deceased) members in the search. Defaults to <code>false</code>.
* Returns: The first <code>Actor</code> found matching the specified role filter. Returns <code>null</code> if no match is found.

=== Functionality ===

* The method searches through the clan's members for the first individual whose role matches the specified <code>roleFilter</code>.
* If <code>inclusivePassive</code> is <code>true</code>, the method includes members who are not currently active (such as deceased members) in the search.
* If multiple members have the specified role, only the first one encountered is returned.

=== Usage ===
This method is ideal for scenarios where a specific role needs to be identified quickly within a clan, such as finding a leader, a healer, or an engineer. It's particularly useful in gameplay mechanics or storylines where individual roles are critical.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class ClanRoleAssignment : MonoBehaviour {
private Clan playerClan;

void Start() {
playerClan = IM.Player.Clan;
if (playerClan != null) {
Actor engineer = playerClan.GetMember("Engineer");
if (engineer != null) {
Debug.Log($"Engineer in the player's clan: {engineer.Name}");
} else {
Debug.Log("No Engineer found in the player's clan.");
}
}
}
}
</syntaxhighlight>

==== Description ====

* This example demonstrates using the <code>GetMember</code> method to find the first member with the role of 'Engineer' in the player's clan.
* It logs the name of the found engineer to the console, or a message indicating that no engineer is found.

=== Remarks ===

* The <code>GetMember</code> method is particularly useful for quickly accessing specific roles within a clan, enhancing gameplay dynamics and narrative development.
* It should be used with the understanding that it returns only the first match, which may not always represent all members with the specified role.

GetMember - Revision history