Table of Contents

Engine

(NOTE) Object cache is use to store objects at runtime.

Methods Properties Base Classes Derived Classes
ClearStore EntryCount
Erase
GetDirectoryPath
GetEntryAt
IsEntryStored
IsStored
Restore
RestoreOrArchetype
Store

Properties


EntryCount : integer

read-only

Get number of entries in the ObjectStore.

var EntryCount : Integer

Methods


ClearStore : Void

Clear the store. |Name|Type|Description| |---|---|---|

function ClearStore()

Erase : Void

Attempts to remove an object from the store. |Name|Type|Description| |---|---|---| |name|string| |

function Erase(name : String)

GetDirectoryPath : string

Returns the directory path to the object store. |Name|Type|Description| |---|---|---|

function GetDirectoryPath() : String

GetEntryAt : string

Get the ObjectStore entry at the specified index. |Name|Type|Description| |---|---|---| |index|integer| |

function GetEntryAt(index : Integer) : String

IsEntryStored : boolean

Is there an entry record for the object in the store? |Name|Type|Description| |---|---|---| |name|string| |

function IsEntryStored(name : String) : Boolean

IsStored : boolean

Name Type Description
string
function IsStored( : String) : Boolean

Restore : cog

Restore an object to the space. |Name|Type|Description| |---|---|---| |name|string| | |space|space| |

function Restore(name : String, space : Space) : Cog

RestoreOrArchetype : cog

Restore an object if it is not stored use the archetype to create it. |Name|Type|Description| |---|---|---| |name|string| | |archetype|archetype| | |space|space| |

function RestoreOrArchetype(name : String, archetype : Archetype, space : Space) : Cog

Store : StoreResult

Store an object. |Name|Type|Description| |---|---|---| |name|string| | |object|cog| |

function Store(name : String, object : Cog) : StoreResult