OptionsAccess Class Reference

Private Member Functions
proto native int	GetAccessType ()
	AccessType of current option.
proto native int	GetControlType ()
	Current option controller type. OA_CT_NUMERIC = 0, OA_CT_SWITCH = 1, OA_CT_LIST = 2.
proto native void	Apply ()
	Applies the option value if the value has changed and forgets the old value. This function has no effect on internal options, see OptionsAccess::Test.
proto native void	Test ()
	Sets the option value internaly if the value has changed and wasnt set immediately upon change.
proto native void	Revert ()
	Reverts the option value to old value if the value has changed and wasnt applied. This function has effect on internal options.
proto native int	IsChanged ()
	If the option value is changed and not applied or reverted. Value can already be set internally if the value was changed immediately.
proto native int	NeedRestart ()
	If the option value will take effect only after the game is restarted.
proto native int	SetChangeImmediately ()
	If the value is changed internally immediately upon change.
proto native int	GetIndex ()
proto native int	GetDefaultIndex ()
proto native void	SetIndex (int index)
proto native int	GetItemsCount ()
proto void	GetItemText (int index, out string value)
void	GetAllItemsText (array< string > output)
proto native void	Switch ()
proto void	GetItemText (out string value)
proto native int	GetIndex ()
proto native int	GetDefaultIndex ()
Script Events API
Setting and getting of ScriptEvents
private proto void	SetScriptEvents (Managed events)
	Set the events.
private proto Managed	GetScriptEvents ()
	Get the events.
OptionsAccessEvents	GetEvents ()
	Get the events.
Events
Events called from C++
void	OnRevert ()

Member Function Documentation

Apply()

proto native void Apply ( )

private

Applies the option value if the value has changed and forgets the old value. This function has no effect on internal options, see OptionsAccess::Test.

GetAccessType()

proto native int GetAccessType ( )

private

AccessType of current option.

Returns

AccessType

GetAllItemsText()

void GetAllItemsText ( array< string >  output )

inlineprivate

References GetItemsCount(), and GetItemText().

GetControlType()

proto native int GetControlType ( )

private

Current option controller type. OA_CT_NUMERIC = 0, OA_CT_SWITCH = 1, OA_CT_LIST = 2.

Returns

ControlType

GetDefaultIndex() [1/2]

proto native int GetDefaultIndex ( )

private

GetDefaultIndex() [2/2]

proto native int GetDefaultIndex ( )

private

GetEvents()

OptionsAccessEvents GetEvents ( )

inlineprivate

Get the events.

Returns

ParticleManagerEvents If there is any events set, this will return them so that additional functionality can be bound to them

References GetScriptEvents().

Referenced by OnRevert().

GetIndex() [1/2]

proto native int GetIndex ( )

private

GetIndex() [2/2]

proto native int GetIndex ( )

private

GetItemsCount()

proto native int GetItemsCount ( )

private

Referenced by GetAllItemsText().

GetItemText() [1/2]

proto void GetItemText ( int  index, out string  value  )

private

Referenced by GetAllItemsText().

GetItemText() [2/2]

proto void GetItemText ( out string  value )

private

GetScriptEvents()

private proto Managed GetScriptEvents ( )

private

Get the events.

Returns

Managed If there is any events set, this will return them

Referenced by GetEvents().

IsChanged()

proto native int IsChanged ( )

private

If the option value is changed and not applied or reverted. Value can already be set internally if the value was changed immediately.

Returns

1 if the value is changed, 0 othewise

NeedRestart()

proto native int NeedRestart ( )

private

If the option value will take effect only after the game is restarted.

Returns

1 if the value is changed, 0 othewise

OnRevert()

void OnRevert ( )

inlineprivate

References OptionsAccessEvents::Event_OnRevert, GetEvents(), and ScriptInvoker::Invoke().

Revert()

proto native void Revert ( )

private

Reverts the option value to old value if the value has changed and wasnt applied. This function has effect on internal options.

SetChangeImmediately()

proto native int SetChangeImmediately ( )

private

If the value is changed internally immediately upon change.

Returns

1 if the value is changed immediately, 0 othewise

SetIndex()

proto native void SetIndex ( int  index )

private

SetScriptEvents()

private proto void SetScriptEvents ( Managed  events )

private

Set the events.

Parameters

events

Managed The events to set

Switch()

proto native void Switch ( )

private

Test()

proto native void Test ( )

private

Sets the option value internaly if the value has changed and wasnt set immediately upon change.

---

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

• P:/scripts/3_Game/gameplay.c