Sequine - Scripting API
Calcatz.Sequine.SequineGlobalData Class Reference

The container of Global Variables, which are basically Variables, except they can be accessed and shared globally, not limited to the scope of the Sequine Flow object. More...

Inheritance diagram for Calcatz.Sequine.SequineGlobalData:
Calcatz.CookieCutter.IVariableUser

Classes

class  DataContainer
 

Static Public Member Functions

static SequineGlobalData GetPersistent ()
 
static SequineGlobalData GetTransient ()
 
static T GetVariable< T > (int _id)
 Gets a global variable. More...
 
static bool TryGetVariable< T > (int _id, out T _value)
 
static void SetVariable< T > (int _id, T _value)
 Sets a global variable. More...
 
static bool TrySetVariable< T > (int _id, T _value)
 
static byte[] SerializeToBinary ()
 Use this to create save data. More...
 
static void DeserializeFromBinary (byte[] _bytes)
 Use this to load data. More...
 

Static Public Attributes

static SequineGlobalData m_persistent
 

Properties

Object targetObject [get]
 
Dictionary< int, CommandData.Variablevariables [getset]
 

Detailed Description

The container of Global Variables, which are basically Variables, except they can be accessed and shared globally, not limited to the scope of the Sequine Flow object.

Member Function Documentation

◆ DeserializeFromBinary()

static void Calcatz.Sequine.SequineGlobalData.DeserializeFromBinary ( byte[]  _bytes)
static

Use this to load data.

Parameters
_bytes

◆ GetPersistent()

static SequineGlobalData Calcatz.Sequine.SequineGlobalData.GetPersistent ( )
static

◆ GetTransient()

static SequineGlobalData Calcatz.Sequine.SequineGlobalData.GetTransient ( )
static

◆ GetVariable< T >()

static T Calcatz.Sequine.SequineGlobalData.GetVariable< T > ( int  _id)
static

Gets a global variable.

Template Parameters
TThe return type of the variable.
Parameters
_idThe integer Id of the variable. (This shows up beside the variable name in the Sequine Global Data window.)
Returns

◆ SerializeToBinary()

static byte[] Calcatz.Sequine.SequineGlobalData.SerializeToBinary ( )
static

Use this to create save data.

Returns

◆ SetVariable< T >()

static void Calcatz.Sequine.SequineGlobalData.SetVariable< T > ( int  _id,
_value 
)
static

Sets a global variable.

Template Parameters
TThe type of the variable.
Parameters
_idThe integer Id of the variable. (This shows up beside the variable name in the Sequine Global Data window.)
_value

◆ TryGetVariable< T >()

static bool Calcatz.Sequine.SequineGlobalData.TryGetVariable< T > ( int  _id,
out T  _value 
)
static

◆ TrySetVariable< T >()

static bool Calcatz.Sequine.SequineGlobalData.TrySetVariable< T > ( int  _id,
_value 
)
static

Member Data Documentation

◆ m_persistent

SequineGlobalData Calcatz.Sequine.SequineGlobalData.m_persistent
static

Property Documentation

◆ targetObject

Object Calcatz.Sequine.SequineGlobalData.targetObject
get

◆ variables

Dictionary<int, CommandData.Variable> Calcatz.Sequine.SequineGlobalData.variables
getset