AC.RuntimeVariables Class Reference

Inheritance diagram for AC.RuntimeVariables:

Public Member Functions
void	OnInitPersistentEngine ()
void	TransferFromManager ()
SpeechLog[]	GetSpeechLog ()
	Gets the game's speech log.
void	ClearSpeechLog ()
void	AddToSpeechLog (SpeechLog _line)
	Adds a speech line to the game's speech log.
void	SetCustomToken (int _ID, string _replacementText)
	Creates a new custom token, or replaces it if one with the same ID number already exists.
void	ClearCustomTokens ()
	Removes all custom tokens from the game.
string	ConvertCustomTokens (string _text)
	Replaces the supplied string with the replacementText of any defined CustomToken classes.
void	AssignCustomTokensFromString (string tokenData)
	Re-assigns the CustomToken variables from a saved string.
void	AssignOptionsLinkedVariables ()
	Transfers the values of all option-linked global variables from the options data into the variables.
MainData	SaveMainData (MainData mainData)
	Updates a MainData class with its own variables that need saving.
void	AssignFromPreset (VarPreset varPreset, bool ignoreOptionLinked=false)
	Assigns all Global Variables to preset values.
void	AssignFromPreset (int varPresetID, bool ignoreOptionLinked=false)
	Assigns all Glocal Variables to preset values.
VarPreset	GetPreset (int varPresetID)
	Gets a Global Variable preset with a specific ID number.

Public Attributes
List< GVar >	globalVars = new List<GVar>()

Protected Member Functions
string	GetCustomTokensAsString ()
void	LinkAllValues ()

Protected Attributes
List< CustomToken >	customTokens = new List<CustomToken>()
List< SpeechLog >	speechLines = new List<SpeechLog>()
string[]	textEventTokenKeys = new string[0]

Properties
string[]	TextEventTokenKeys [get, set]

Detailed Description

Stores the game's global variables at runtime, as well as the speech log. This component should be attached to the PersistentEngine prefab.

Member Function Documentation

AddToSpeechLog()

void AC.RuntimeVariables.AddToSpeechLog

(

SpeechLog

_line

)

Adds a speech line to the game's speech log.

Parameters

_line

The SpeechLog variable to add

AssignCustomTokensFromString()

void AC.RuntimeVariables.AssignCustomTokensFromString

(

string

tokenData

)

Re-assigns the CustomToken variables from a saved string.

Parameters

savedString

The string that contains the CustomToken variables data

AssignFromPreset() [1/2]

void AC.RuntimeVariables.AssignFromPreset	(	int	varPresetID,
		bool	ignoreOptionLinked = false )

Assigns all Glocal Variables to preset values.

Parameters

varPresetID	The ID number of the VarPreset that contains the preset values
ignoreOptionLinked	If True, then variables linked to Options Data will not be affected

AssignFromPreset() [2/2]

void AC.RuntimeVariables.AssignFromPreset	(	VarPreset	varPreset,
		bool	ignoreOptionLinked = false )

Assigns all Global Variables to preset values.

Parameters

varPreset	The VarPreset that contains the preset values
ignoreOptionLinked	If True, then variables linked to Options Data will not be affected

ClearSpeechLog()

void AC.RuntimeVariables.ClearSpeechLog

(

)

Clears the game's speech log.

ConvertCustomTokens()

string AC.RuntimeVariables.ConvertCustomTokens

(

string

_text

)

Replaces the supplied string with the replacementText of any defined CustomToken classes.

Parameters

_text

The supplied string that may contain tokens of the form '[token:ID]'

Returns

The supplied string with any tokens replaced with the appropriate CustomToken's replacementText

GetPreset()

VarPreset AC.RuntimeVariables.GetPreset

(

int

varPresetID

)

Gets a Global Variable preset with a specific ID number.

Parameters

varPresetID

The ID number of the VarPreset

Returns

The Global Variable preset

GetSpeechLog()

SpeechLog[] AC.RuntimeVariables.GetSpeechLog

(

)

Gets the game's speech log.

Returns

An array of SpeechLog variables

OnInitPersistentEngine()

void AC.RuntimeVariables.OnInitPersistentEngine

(

)

Links all variables to their linked counterpart.

SaveMainData()

MainData AC.RuntimeVariables.SaveMainData

(

MainData

mainData

)

Updates a MainData class with its own variables that need saving.

Parameters

mainData

The original MainData class

Returns

The updated MainData class

SetCustomToken()

void AC.RuntimeVariables.SetCustomToken	(	int	_ID,
		string	_replacementText )

Creates a new custom token, or replaces it if one with the same ID number already exists.

Parameters

_ID	The token's unique identifier
_replacementText	The token's replacement text.

TransferFromManager()

void AC.RuntimeVariables.TransferFromManager

(

)

Downloads variables from the Global Manager to the scene.

Member Data Documentation

globalVars

List<GVar> AC.RuntimeVariables.globalVars = new List<GVar>()

The List of the game's global variables.

Property Documentation

TextEventTokenKeys

string [] AC.RuntimeVariables.TextEventTokenKeys

getset

An array of string keys that can be inserted into text fields in the form [key:value]. When processed, they will be removed from the text, but will trigger the OnRequestTextTokenReplacement event.