⁘ common.helpers

OptionsObject

An OptionObject is an extension over the DisposableObjectEx with a builtin common.helpers.OptionHandler.
It is a glorified Object

go to → Members

Extends

Broadcasting

This section list the main methods used to watch/unwatch signals on this object. For more info on signals, see signals

Methods

Unwatch(p_signal, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

Watch(p_signal, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

WatchOnce(p_signalId, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

protected_Broadcast(p_signal, …args)

Inherited From:
Initialization

Methods

protectedoverride-me_Init()

Inherited From:

protectedoverride-me_PostInit()

Inherited From:
Utils

Methods

protected_Bind(p_func)

Inherited From:
Pooling

Group of methods related to the NKMjs pooling system.

Members

read-onlyisReleasing :boolean

Inherited From:

Methods

Release()

Inherited From:

protectedoverride-me_CleanUp()

Inherited From:
Misc

Members

optionHandler :common.helpers.OptionsHandler

TODO

options :object

TODO

Methods

AppendOptions(p_options)

TODO

Parameters:
Name Type Description
p_options object

GetOption(p_id, p_fallback)

Return the option value at specified id.
Return the fallback value in case no option exists.

Parameters:
Name Type Default Description
p_id string
p_fallback * null

GetOrSetOption(p_id, p_fallback)

Return the option value at specified id.
Return the fallback value in case no option exists.

Parameters:
Name Type Default Description
p_id string
p_fallback * null

PreventRelease()

Inherited From:

SetOption(p_id, p_value)

Set the value of the option with the specified id.

Parameters:
Name Type Description
p_id string
p_value *