Tayfunwiki: Created page with "= `GetVariable` Method Documentation = == Description == The `GetVariable` methods allow for retrieving a private variable from a clan based on its name or ID. These methods come in two variants: a non-generic version that returns the variable as a base type, and a generic version that returns the variable cast to a specified type. == Method Signatures == === GetVariable (Non-Generic) === public NVar GetVariable(string..."

2024-08-04T16:17:19Z

Created page with "= <code>GetVariable</code> Method Documentation = == Description == The <code>GetVariable</code> methods allow for retrieving a private variable from a clan based on its name or ID. These methods come in two variants: a non-generic version that returns the variable as a base type, and a generic version that returns the variable cast to a specified type. == Method Signatures == === GetVariable (Non-Generic) === <syntaxhighlight lang="c#"> public NVar GetVariable(string..."

New page

= <code>GetVariable</code> Method Documentation =

== Description ==
The <code>GetVariable</code> methods allow for retrieving a private variable from a clan based on its name or ID. These methods come in two variants: a non-generic version that returns the variable as a base type, and a generic version that returns the variable cast to a specified type.

== Method Signatures ==

=== GetVariable (Non-Generic) ===
<syntaxhighlight lang="c#">
public NVar GetVariable(string variableNameOrId)
</syntaxhighlight>This method retrieves the variable with the specified name or ID from the clan. It returns the variable as an <code>NVar</code>.

=== GetVariable (Generic) ===
<syntaxhighlight lang="c#">
public T GetVariable<T>(string variableNameOrId) where T : NVar
</syntaxhighlight>This method retrieves the variable with the specified name or ID from the clan and casts it to the specified type <code>T</code>. It returns the variable as <code>T</code>.

== Example Usage ==

=== Non-Generic Usage ===
<syntaxhighlight lang="c#">
NVar variable = IM.Player.Clan.GetVariable("someVariable");
Debug.Log(variable.Value);
</syntaxhighlight>Retrieves the variable <code>someVariable</code> and logs its value.

=== Generic Usage ===
<syntaxhighlight lang="c#">
NBool booleanVar = IM.Player.Clan.GetVariable<NBool>("booleanVariable");
Debug.Log(booleanVar.Value);
</syntaxhighlight>Retrieves the variable <code>booleanVariable</code> and casts it to an <code>NBool</code> type. The <code>booleanVar.Value</code> property returns the value as a <code>bool</code>.

'''Note''': <code>booleanVar.Value</code> will return the value as a boolean type (<code>bool</code>).

GetClanVariable - Revision history