LegoOmni::WorldContainer Struct Reference

[AI] Associates a world enum, key, and AtomId for dynamic world lookup, Atom-based registry, and key-string identification. More...

#include <legomain.h>

Collaboration diagram for LegoOmni::WorldContainer:

Public Member Functions
	WorldContainer ()
	[AI] Default constructor. More...
	WorldContainer (World p_id, const char *p_key, MxAtomId *p_atomId)
	[AI] Construct a WorldContainer from enum id, string key, and AtomId pointer. More...
WorldContainer &	operator= (const WorldContainer &p_container)
	[AI] Copy assignment operator. More...
World	GetId ()
	[AI] Returns world identifier. More...
const char *	GetKey ()
	[AI] Returns world string key. More...

Public Attributes
World	m_id
	[AI] World enum identifier. More...
char	m_key [20]
	[AI] String key for this world (used for script/world lookup). More...
MxAtomId *	m_atomId
	[AI] AtomId pointer for this world's script. More...

Detailed Description

[AI] Associates a world enum, key, and AtomId for dynamic world lookup, Atom-based registry, and key-string identification.

[AI]

[AI] Used internally in LegoOmni as a world table for fast world script and Atom lookup by enum, string, or AtomId. [AI]

Definition at line 85 of file legomain.h.

Constructor & Destructor Documentation

WorldContainer() [1/2]

LegoOmni::WorldContainer::WorldContainer ( )

inline

[AI] Default constructor.

Sets world to undefined and AtomId to NULL.

Definition at line 89 of file legomain.h.

WorldContainer() [2/2]

LegoOmni::WorldContainer::WorldContainer ( World  p_id, const char *  p_key, MxAtomId *  p_atomId  )

inline

[AI] Construct a WorldContainer from enum id, string key, and AtomId pointer.

Parameters

p_id	[AI] World enum identifier for this container.
p_key	[AI] String key associated with the world (e.g. "ACT1").
p_atomId	[AI] AtomId pointer for script identification.

Definition at line 101 of file legomain.h.

Member Function Documentation

GetId()

World LegoOmni::WorldContainer::GetId ( )

inline

[AI] Returns world identifier.

Returns

[AI] World enum of this container.

Definition at line 129 of file legomain.h.

GetKey()

const char * LegoOmni::WorldContainer::GetKey ( )

inline

[AI] Returns world string key.

Returns

[AI] Key string used for registry and lookup.

Definition at line 135 of file legomain.h.

operator=()

WorldContainer & LegoOmni::WorldContainer::operator= ( const WorldContainer &  p_container )

inline

[AI] Copy assignment operator.

Parameters

p_container

[AI] Container to copy from.

Returns

[AI] Reference to self.

Definition at line 117 of file legomain.h.

Member Data Documentation

m_atomId

MxAtomId* LegoOmni::WorldContainer::m_atomId

[AI] AtomId pointer for this world's script.

Definition at line 139 of file legomain.h.

m_id

World LegoOmni::WorldContainer::m_id

[AI] World enum identifier.

Definition at line 137 of file legomain.h.

m_key

char LegoOmni::WorldContainer::m_key[20]

[AI] String key for this world (used for script/world lookup).

Definition at line 138 of file legomain.h.

---

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

• legomain.h