⁘ documents

Document

A document is wrapper for a resource and a data object. It aims at streamlining working with custom datatype & saving them.

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

currentData :io.core.DataBlock

TODO

currentPath :string

TODO

currentRsc :io.core.Resource

TODO

read-onlyisDirty :boolean

True if the DataBlock is dirty, otherwise false

Methods

_Pack()

Called when the ressource has started writing its data (not before) Used as rsc._serializeFn

ClearDirty()

TODO

Delete(p_options)

TODO

Parameters:
Name Type Default Description
p_options object null

Dirty()

TODO

Load(p_options)

TODO

Parameters:
Name Type Default Description
p_options object null

PreventRelease()

Inherited From:

Save(p_options)

TODO

Parameters:
Name Type Default Description
p_options object null

protected_OnReadComplete(p_rsc)

Use the resource's unserialized content to rebuild a typed data object through this document's serializer

Parameters:
Name Type Description
p_rsc *

protected_Unpack(p_content)

Called when the linked ressource has successfully loaded. Use the serializer in NFO to unserialize resource

Parameters:
Name Type Description
p_content *