PUBLIC

WorldBodyC::WorldBodyC(StringC) WorldBodyC::Init(void) WorldBodyC::AddRoom(const StringC &) WorldBodyC::AddPortal(const RoomC &,const RoomC &,StringC) WorldBodyC::AddObject(ObjectC &) WorldBodyC::AddObject(StringC) WorldBodyC::AddPlayer(StringC,const RoomC &) WorldBodyC::Object(const VLSymbC &) WorldBodyC::Portal(const VLSymbC &) WorldBodyC::Room(const StringC &) WorldBodyC::RoomNode(const RoomC &) WorldBodyC::operator==(const WorldBodyC &) const WorldBodyC::Goal(void) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const RefCounterBaseC::Label(void) const

WorldBodyC
Get handle to myself. World body
include	"amma/Logic2/DarkCastle.hh"
User Level:	Default
Library:	VLWorld
Example:	exIndex.cc
Section:	Logic.World
In Scope:	DarkCastle

Parent Classes:

public BodyRefCounterC

WorldBodyC(StringC name)

Default constructor.

ind	Index of types of intererest.

void Init()

Create default world.

ind	Index of types of intererest.

RoomC AddRoom(const StringC & name)

Add a new room.

ind	Index of types of intererest.

returns a handle to the new room.

PortalC AddPortal(const RoomC & from,const RoomC & to,StringC name)

Construct a portal between two rooms.

ind	Index of types of intererest.

returns a handle to the new portal.

ObjectC AddObject(ObjectC & obj)

Add a new object to the world.

ind	Index of types of intererest.

returns a handle to the object.

ObjectC AddObject(StringC name)

Add a new object to the world.

ind	Index of types of intererest.

returns a handle to the object.

PlayerC AddPlayer(StringC name,const RoomC & where)

Add a new player to the world.

ind	Index of types of intererest.

returns a handle to the player.

ObjectC Object(const VLSymbC &)

Find object.

ind	Index of types of intererest.

Will return an invalid object if not found.

PortalC Portal(const VLSymbC &)

Find portal.

ind	Index of types of intererest.

Will return an invalid portal if not found.

RoomC Room(const StringC & roomNm)

Get room by name.

ind	Index of types of intererest.

(SLOW).

GraphNodeHC<RoomC,PortalC> RoomNode(const RoomC & at)

Get room node.

ind	Index of types of intererest.

BooleanT operator==(const WorldBodyC & obj) const

Comparison operator.

ind	Index of types of intererest.

const VLSymbC & Goal() const

Get goal for world.

ind	Index of types of intererest.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.