DSGameConfig Interface Reference

Inheritance diagram for DSGameConfig:

Public Member Functions
void	DSGameConfig ()
override void	OnPack ()
	Event when pack starts - you will pack your stuff here.
override void	OnExpand ()
	Event when expand (unpack) process starts.
Public Member Functions inherited from JsonApiStruct
void	JsonApiStruct ()
void	~JsonApiStruct ()
void	OnExpand ()
	Event when expand (unpack) process starts.
void	OnPack ()
	Event when pack starts - you will pack your stuff here.
void	OnSuccess (int errorCode)
	Event called when pending store operation is finished - callback from JsonApiHandle before handle release.
void	OnError (int errorCode)
	Event called when pending store operation is finished - callback from JsonApiHandle before handle release.
void	OnObject (string name)
	Called when parsing object.
void	OnStartArray (string name)
	Called when parsing array.
void	OnEndArray (int itemCount)
	Called when array end, returns count of items.
void	OnItemObject (int index, string name)
	Called when parsing object.
proto native void	RegV (string name)
	Register script variable for auto-feature.
proto native void	UnregV (string name)
	Unregister script variable for auto-feature.
proto native void	RegAll ()
	Register all variable present on object for auto-feature (it is not recursive!)
proto native void	Push (JsonApiStruct obj)
	Push object to parse (only during parse operation)
proto native void	StartObject (string name)
	Start object at hierarchy - !!! Be cautious and doublecheck results when using this !!!
proto native void	EndObject ()
	End object at hierarchy - !!! Be cautious and doublecheck results when using this !!!
proto native void	StoreObject (string name, JsonApiStruct obj)
	Add scripted object to hierarchy (calls through hierarchy)
proto native void	StoreFloat (string name, float value)
	Add float value to hierarchy.
proto native void	StoreInteger (string name, int value)
	Add integer value to hierarchy.
proto native void	StoreBoolean (string name, bool value)
	Add boolean value to hierarchy.
proto native void	StoreString (string name, string value)
	Add string value to hierarchy.
proto native void	StoreVector (string name, vector value)
	Add vector value to hierarchy.
proto native void	StartArray (string name)
	Start array at hierarchy - !!! Be cautious and doublecheck results when using this !!!
proto native void	EndArray ()
	End array at hierarchy - !!! Be cautious and doublecheck results when using this !!!
proto native void	ItemObject (JsonApiStruct obj)
	Add scripted unnamed/ array object.
proto native void	ItemFloat (float value)
	Add unnamed/ array float value.
proto native void	ItemInteger (int value)
	Add unnamed/ array integer value.
proto native void	ItemBoolean (bool value)
	Add unnamed/ array boolean value.
proto native void	ItemString (string value)
	Add unnamed/ array string value.
proto native void	ItemVector (vector value)
	Add unnamed/ array vector value.
proto native void	ItemArray ()
	Start an array inside an array.
proto native void	SetDone ()
	Call this when you've done packing or unpacking (interrupt operation)
proto native void	SetFail ()
	Call this when you've done packing or unpacking + want to generate error - prevent to send invalid data etc.
proto native void	Pack ()
	Start object packing now - for use at main thread only!
proto native void	ExpandFromRAW (string data)
	Start object unpacking from RAW string data.
proto native string	AsString ()
	Get packed JSON as string (!only if you called Pack() first, it may return null)
proto native bool	HasData ()
	Return true if there are present JSON data which can be expanded on script object (typically you check this after load of file)
proto native bool	PackToFile (string FileName)
	Pack() and save JSON to file.
proto native bool	SaveToFile (string FileName)
	Save JSON to file (only If something was loaded or recieved previously!)
proto native bool	LoadFromFile (string FileName)
	Load JSON from file and Expand.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Public Attributes
string	name
string	scenarioId
string	hostedScenarioModId
int	maxPlayers
string	password
string	passwordAdmin
bool	visible
bool	crossPlatform
ref DSGameProperties	gameProperties
ref array< ref DSMod >	mods

Constructor & Destructor Documentation

DSGameConfig()

void DSGameConfig.DSGameConfig

(

)

Member Function Documentation

OnExpand()

override void DSGameConfig.OnExpand

(

)

Event when expand (unpack) process starts.

Implements JsonApiStruct.

OnPack()

override void DSGameConfig.OnPack

(

)

Event when pack starts - you will pack your stuff here.

Implements JsonApiStruct.

Member Data Documentation

crossPlatform

bool DSGameConfig.crossPlatform

gameProperties

ref DSGameProperties DSGameConfig.gameProperties

hostedScenarioModId

string DSGameConfig.hostedScenarioModId

maxPlayers

int DSGameConfig.maxPlayers

mods

ref array<ref DSMod> DSGameConfig.mods

name

string DSGameConfig.name

password

string DSGameConfig.password

passwordAdmin

string DSGameConfig.passwordAdmin

scenarioId

string DSGameConfig.scenarioId

visible

bool DSGameConfig.visible

---

The documentation for this interface was generated from the following file:

• GameLib/online/DSConfig.c