create a new raw game entity by type name, extend this method in subclasses for new types

Create a raw entity by its C++ class name name. This method should be extended by subclasses if a Mangalore application implements new Game::Entity subclasses.

create a new entity from its category name

Create an entity from its category name. The category name is looked up in the blueprints.xml file to check what properties must be attached to the entity. All required properties will be attached, and all attributes will be initialised according to the attribute table.

create a new entity from scratch and initialize it with the provided attributes

Create a new entity from scratch and initialize it with the provided attributes.

create a new entity from a database template entry

Create an entity from a template in the database. The template is defined by category name and the template name defined by the the Attr::Id attribute. This will create a complete entity with properties and attributes initialized to the values from the template. A new GUID will be assigned to the entity.

create a new entity from a database template entry, and add it into a different category

Create a new entity from a template, but put the entity into a different category.

create a new entity cloning an existing one

Create a entity as a clone of a existing one. A new GUID will be assigned.

create a new entity in a different category cloning an existing one

Create a entity as a clone of a existing one but in a different category as the original entity. A new GUID will be assigned.

create new entity from world database using any key attribute

This will 'load' a new entity from the world database. This will create a new entity, attach properties as described by blueprints.xml, and update the entity attributes from the database. Changes to attributes can later be written back to the database by calling the Entity::Save() method.

NOTE: this method will not call the Entity::OnLoad() method, which may be required to finally initialize the entity. The OnLoad() method expects that all other entities in the level have already been loaded, so this must be done after loading in a separate pass.

NOTE: use this method only if you know there's only one matching entity in the database (for instance by Guid attribute), otherwise, use the CreateEntitiesByKeyAttr() method, which checks all matches.

create new entity from world database using GUID as key attribute

Creates a new entity from the world database using a GUID as key. Simply calls CreateEntityByKeyAttr().

create a new property by type name, extend in subclass for new types

Create a property by its type name. This method should be extended by subclasses if a Mangalore application implements new properties.

add properties to entity according to blue print

This method checks if a blueprint for the provided entity exists, and adds the properties defined in the blue print to the entity. If no matching blueprint exists, the entity will not be altered.

setup attributes on properties

Create the properties of every category and call SetupDefaultAttributes on it.

parse entity blueprints file

This method parses the file data:tables/blueprints.xml into the bluePrints array.

find blueprint index by property type

This method finds a blueprint index by entity type name. Returns InvalidIndex if blueprint doesn't exist.

called when attached to game server

This method is called when the manager is attached to the game server. The manager base class will register its message port with the message server.

Reimplemented in BaseGameFeature::TimeManager, BaseGameFeature::CategoryManager, BaseGameFeature::EnvQueryManager, BaseGameFeature::GlobalAttrsManager, Script::DialogManager, and Script::ScriptManager.

called when removed from game server

This method is called when the manager is removed from the game server. It will unregister its message port from the message server at this point.

Reimplemented in BaseGameFeature::TimeManager, BaseGameFeature::CategoryManager, BaseGameFeature::EntityManager, BaseGameFeature::EnvEntityManager, BaseGameFeature::EnvQueryManager, Script::DialogManager, and Script::ScriptManager.

called before frame by the game server

Called before frame, override in subclasses

Reimplemented in BaseGameFeature::EntityManager.

called after frame by the game server

Called after frame, override in subclasses

Reimplemented in BaseGameFeature::EntityManager.

handle a single message (distribute to ports which accept the message)

Handle a message. The message will only be distributed to ports which accept the message.

Reimplemented from Messaging::Port.

Reimplemented in Script::DialogManager.

attach a message port

Attach a new message port.

Parameters:

port

pointer to a message port object

remove a message port

Remove a message port object.

Parameters:

handler

pointer to message port object to be removed

return true if a port exists

Return true if a port is already attached.

attach a message handler to the port

Attach a message handler to the port.

remove a message handler from the port

Remove a message handler from the port.

send a message to the port

Send a message to the port. This will immediately call the HandleMessage() method of all attached handlers. If the message has been handled by at least one of the handlers, the Handled() flag of the message will be set to true.

get the current refcount

Return the current refcount of the object.

increment refcount by one

Increment the refcount of the object.

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

get the class name

Get the class name of the object.

get the class FourCC code

Get the class FourCC of the object.

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.