Tayfunwiki: Created page with "= `SetVariable` Method Documentation = == Description == The `SetVariable` methods allow for setting the value of a private variable within a clan. These methods come in two variants: a non-generic version that simply sets the value, and a generic version that sets the value and returns it cast to a specified type. == Method Signatures == === SetVariable (Non-Generic) === public void SetVariable(string variableNameOrId..."

2024-08-04T16:14:08Z

Created page with "= <code>SetVariable</code> Method Documentation = == Description == The <code>SetVariable</code> methods allow for setting the value of a private variable within a clan. These methods come in two variants: a non-generic version that simply sets the value, and a generic version that sets the value and returns it cast to a specified type. == Method Signatures == === SetVariable (Non-Generic) === <syntaxhighlight lang="c#"> public void SetVariable(string variableNameOrId..."

New page

= <code>SetVariable</code> Method Documentation =

== Description ==
The <code>SetVariable</code> methods allow for setting the value of a private variable within a clan. These methods come in two variants: a non-generic version that simply sets the value, and a generic version that sets the value and returns it cast to a specified type.

== Method Signatures ==

=== SetVariable (Non-Generic) ===
<syntaxhighlight lang="c#">
public void SetVariable(string variableNameOrId, object value)
</syntaxhighlight>This method sets the value of a specified variable without returning it. If the variable does not exist, no action is taken.

=== SetVariable (Generic) ===
<syntaxhighlight lang="c#">
public T SetVariable<T>(string variableNameOrId, object value) where T : NVar
</syntaxhighlight>This method sets the value of a specified variable and returns the updated variable cast to the specified type <code>T</code>. If the variable does not exist, it returns <code>null</code>.

== Example Usage ==

=== Non-Generic Usage ===
<syntaxhighlight lang="c#">
IM.Player.Clan.SetVariable("booleanVariable", true);
</syntaxhighlight>Sets the value of the variable <code>booleanVariable</code> to <code>true</code> for the player's clan.

=== Generic Usage ===
<syntaxhighlight lang="c#">
var booleanVar = IM.Player.Clan.SetVariable<NBool>("booleanVariable", true);
Debug.Log(booleanVar.Value);
</syntaxhighlight>Sets the value of the variable <code>booleanVariable</code> to <code>true</code> and retrieves it as 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>).

SetClanVariable - Revision history