Tayfunwiki: Created page with "== `GetVariable` Methods in Actor Class == === Overview === The `GetVariable` methods in the `Actor` class are used to retrieve private variables of different types from an actor. These methods are essential in games where actors have customizable attributes or states stored as variables. === Method Variations === # GetVariable (Generic Type): Retrieves a private variable and casts it to a specified type. # GetVariable (NVar Type): Ret..."

2023-12-24T11:57:33Z

Created page with "== <code>GetVariable</code> Methods in Actor Class == === Overview === The <code>GetVariable</code> methods in the <code>Actor</code> class are used to retrieve private variables of different types from an actor. These methods are essential in games where actors have customizable attributes or states stored as variables. === Method Variations === # GetVariable (Generic Type): Retrieves a private variable and casts it to a specified type. # GetVariable (NVar Type): Ret..."

New page

== <code>GetVariable</code> Methods in Actor Class ==

=== Overview ===
The <code>GetVariable</code> methods in the <code>Actor</code> class are used to retrieve private variables of different types from an actor. These methods are essential in games where actors have customizable attributes or states stored as variables.

=== Method Variations ===

# GetVariable (Generic Type): Retrieves a private variable and casts it to a specified type.
# GetVariable (NVar Type): Retrieves a private variable as a general <code>NVar</code> object.

=== Syntax ===

# Generic Type:<syntaxhighlight lang="c#">
public T GetVariable<T>(string variableNameOrId) where T : NVar
</syntaxhighlight>
# NVar Type:<syntaxhighlight lang="c#">
public T GetVariable<T>(string variableNameOrId) where T : NVar
</syntaxhighlight>

=== Parameters ===

* variableNameOrId (string): The name or ID of the variable to be retrieved.

=== Description ===

* Generic Type: Retrieves a variable and casts it to a specific type, such as <code>NString</code>, <code>NInt</code>, <code>NFloat</code>, <code>NObject</code>, <code>NBool</code>, or <code>NEnum</code>.
* NVar Type: Retrieves a variable as a general <code>NVar</code> object without specifying the type.

=== Usage ===
Used to access and utilize various actor-specific data, enhancing gameplay flexibility and character customization.

=== Examples of Usage ===

# Generic Type (NInt for Gold Amount):<syntaxhighlight lang="c#">
public Actor character;
string varName = "Gold";

NInt gold = character.GetVariable<NInt>(varName);
// Use 'gold' for logic related to the character's gold amount
</syntaxhighlight>
# NVar Type (Generic Variable Retrieval):<syntaxhighlight lang="c#">
public Actor character;
string varName = "Health";

NVar healthVar = character.GetVariable(varName);
// Use 'healthVar' for generic health-related logic
</syntaxhighlight>

=== Remarks ===

* The <code>GetVariable</code> methods provide crucial functionality for dynamic game mechanics where characters' attributes and states influence gameplay and narrative.
* The ability to retrieve variables in both typed and untyped forms offers flexibility and type safety, catering to various gameplay scenarios.
* These methods are particularly useful in RPGs, simulation games, and any game that requires in-depth character attribute management.

GetVariable - Revision history