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

2024-08-05T12:52:24Z

Created page with "= <code>GetVariable</code> Method Documentation = == Description == The <code>GetVariable</code> methods allow for retrieving a private variable from the family based on its name or ID. These methods come in two variants: a non-generic version that retrieves the variable and a generic version that retrieves the variable and casts it 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 the family based on its name or ID. These methods come in two variants: a non-generic version that retrieves the variable and a generic version that retrieves the variable and casts it 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 family.

=== 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 family and casts it to the specified type <code>T</code>.

== Example Usage ==

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

=== Generic Usage ===
<syntaxhighlight lang="c#">
NBool booleanVar = IM.Player.Family.GetVariable<NBool>("booleanVariable");
Debug.Log(booleanVar.Value);
</syntaxhighlight>Retrieves the <code>booleanVariable</code> from the family, casts it to an <code>NBool</code> type, and logs its boolean value.

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

GetFamilyVariable - Revision history