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
proto external void	RegV (string name)
	Register script variable for automatic processing of JSON stream.
proto external void	UnregV (string name)
	Unregister script variable from automatic processing of JSON stream.
proto external void	RegAll ()
	Register all variable present on object for auto processing (it is not recursive!)
proto external void	StartObject (string name)
	Start object at hierarchy - !
proto external void	EndObject ()
	End object at hierarchy - !
proto external void	StoreObject (string name, JsonApiStruct obj)
	Add scripted object to hierarchy (calls through hierarchy)
proto external void	StoreFloat (string name, float value)
	Add float value to hierarchy.
proto external void	StoreInteger (string name, int value)
	Add integer value to hierarchy.
proto external void	StoreBoolean (string name, bool value)
	Add boolean value to hierarchy.
proto external void	StoreString (string name, string value)
	Add string value to hierarchy.
proto external void	StoreVector (string name, vector value)
	Add vector value to hierarchy.
proto external void	StartArray (string name)
	Start array at hierarchy - !
proto external void	EndArray ()
	End array at hierarchy - !
proto external void	ItemObject (JsonApiStruct obj)
	Add scripted unnamed/ array object.
proto external void	ItemFloat (float value)
	Add unnamed/ array float value.
proto external void	ItemInteger (int value)
	Add unnamed/ array integer value.
proto external void	ItemBoolean (bool value)
	Add unnamed/ array boolean value.
proto external void	ItemString (string value)
	Add unnamed/ array string value.
proto external void	ItemVector (vector value)
	Add unnamed/ array vector value.
proto external void	ItemArray ()
	Start an array inside an array.
proto external void	Pack ()
	Create JSON data from this object.
proto external void	ExpandFromRAW (string data)
	Start object initialization from provided RAW string data.
proto external string	AsString ()
	Get object as JSON string (If no data are present - empty JSON string object is passed)
proto external bool	HasData ()
	Return true if stringified JSON are present (readable as string)
proto external bool	PackToFile (string FileName)
	Create JSON data and save it to file.
proto external bool	SaveToFile (string FileName)
	Save to file (only if data are present from previous operation - load for example) as JSON data.
proto external bool	LoadFromFile (string FileName)
	Load JSON from file and use it to initialize this object.
void	OnSuccess (int errorCode)
	Event called when operation finished with Success errorCode is EJsonApiError.
void	OnError (int errorCode)
	Event called when operation finished with Error errorCode is EJsonApiError.
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.
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