Pyrogenesis trunk
|
#include <ComponentManager.h>
Classes | |
struct | ComponentType |
Public Types | |
typedef int | InterfaceId |
typedef int | ComponentTypeId |
typedef int | MessageTypeId |
using | InterfacePair = std::pair< entity_id_t, IComponent * > |
using | InterfaceList = std::vector< InterfacePair > |
using | InterfaceListUnordered = std::unordered_map< entity_id_t, IComponent * > |
Public Member Functions | |
CComponentManager (CSimContext &, ScriptContext &cx, bool skipScriptFunctions=false) | |
~CComponentManager () | |
void | LoadComponentTypes () |
bool | LoadScript (const VfsPath &filename, bool hotload=false) |
Load a script and execute it in a new function scope. More... | |
void | RegisterMessageType (MessageTypeId mtid, const char *name) |
void | RegisterComponentType (InterfaceId, ComponentTypeId, AllocFunc, DeallocFunc, const char *, const std::string &schema) |
void | RegisterComponentTypeScriptWrapper (InterfaceId, ComponentTypeId, AllocFunc, DeallocFunc, const char *, const std::string &schema) |
void | MarkScriptedComponentForSystemEntity (CComponentManager::ComponentTypeId cid) |
void | SubscribeToMessageType (MessageTypeId mtid) |
Subscribe the current component type to the given message type. More... | |
void | SubscribeGloballyToMessageType (MessageTypeId mtid) |
Subscribe the current component type to all messages of the given message type. More... | |
void | DynamicSubscriptionNonsync (MessageTypeId mtid, IComponent *component, bool enabled) |
Subscribe the given component instance to all messages of the given message type. More... | |
ComponentTypeId | LookupCID (const std::string &cname) const |
std::string | LookupComponentTypeName (ComponentTypeId cid) const |
void | InitSystemEntity () |
Set up an empty SYSTEM_ENTITY. More... | |
CEntityHandle | GetSystemEntity () |
Returns a CEntityHandle with id SYSTEM_ENTITY. More... | |
CEntityHandle | LookupEntityHandle (entity_id_t ent, bool allowCreate=false) |
Returns a CEntityHandle with id ent . More... | |
bool | EntityExists (entity_id_t ent) const |
Returns true if the entity with id ent exists. More... | |
entity_id_t | AllocateNewEntity () |
Returns a new entity ID that has never been used before. More... | |
entity_id_t | AllocateNewLocalEntity () |
Returns a new local entity ID that has never been used before. More... | |
entity_id_t | AllocateNewEntity (entity_id_t preferredId) |
Returns a new entity ID that has never been used before. More... | |
bool | AddComponent (CEntityHandle ent, ComponentTypeId cid, const CParamNode ¶mNode) |
Constructs a component of type 'cid', initialised with data 'paramNode', and attaches it to entity 'ent'. More... | |
void | AddSystemComponents (bool skipScriptedComponents, bool skipAI) |
Add all system components to the system entity (skip the scripted components or the AI components on demand) More... | |
void | AddMockComponent (CEntityHandle ent, InterfaceId iid, IComponent &component) |
Adds an externally-created component, so that it is returned by QueryInterface but does not get destroyed and does not receive messages from the component manager. More... | |
IComponent * | ConstructComponent (CEntityHandle ent, ComponentTypeId cid) |
Allocates a component object of type 'cid', and attaches it to entity 'ent'. More... | |
entity_id_t | AddEntity (const std::wstring &templateName, entity_id_t ent) |
Constructs an entity based on the given template, and adds it the world with entity ID ent . More... | |
void | DestroyComponentsSoon (entity_id_t ent) |
Destroys all the components belonging to the specified entity when FlushDestroyedComponents is called. More... | |
void | FlushDestroyedComponents () |
Does the actual destruction of components from DestroyComponentsSoon. More... | |
IComponent * | QueryInterface (entity_id_t ent, InterfaceId iid) const |
InterfaceList | GetEntitiesWithInterface (InterfaceId iid) const |
const InterfaceListUnordered & | GetEntitiesWithInterfaceUnordered (InterfaceId iid) const |
void | PostMessage (entity_id_t ent, const CMessage &msg) |
Send a message, targeted at a particular entity. More... | |
void | BroadcastMessage (const CMessage &msg) |
Send a message, not targeted at any particular entity. More... | |
void | ResetState () |
Resets the dynamic simulation state (deletes all entities, resets entity ID counters; doesn't unload/reload component scripts). More... | |
void | SetRNGSeed (u32 seed) |
Initializes the random number generator with a seed determined by the host. More... | |
bool | ComputeStateHash (std::string &outHash, bool quick) const |
bool | DumpDebugState (std::ostream &stream, bool includeDebugInfo) const |
bool | SerializeState (std::ostream &stream) const |
bool | DeserializeState (std::istream &stream) |
std::string | GenerateSchema () const |
ScriptInterface & | GetScriptInterface () |
Private Types | |
enum | EComponentTypeType { CT_Native , CT_ScriptWrapper , CT_Script } |
using | AllocFunc = IComponent::AllocFunc |
using | DeallocFunc = IComponent::DeallocFunc |
Private Member Functions | |
NONCOPYABLE (CComponentManager) | |
void | Script_RegisterComponentType_Common (int iid, const std::string &cname, JS::HandleValue ctor, bool reRegister, bool systemComponent) |
void | Script_RegisterComponentType (int iid, const std::string &cname, JS::HandleValue ctor) |
void | Script_RegisterSystemComponentType (int iid, const std::string &cname, JS::HandleValue ctor) |
void | Script_ReRegisterComponentType (int iid, const std::string &cname, JS::HandleValue ctor) |
void | Script_RegisterInterface (const std::string &name) |
void | Script_RegisterMessageType (const std::string &name) |
void | Script_RegisterGlobal (const std::string &name, JS::HandleValue value) |
std::vector< int > | Script_GetEntitiesWithInterface (int iid) |
std::vector< IComponent * > | Script_GetComponentsWithInterface (int iid) |
void | Script_PostMessage (int ent, int mtid, JS::HandleValue data) |
void | Script_BroadcastMessage (int mtid, JS::HandleValue data) |
int | Script_AddEntity (const std::wstring &templateName) |
int | Script_AddLocalEntity (const std::wstring &templateName) |
const CParamNode & | Script_GetTemplate (const std::string &templateName) |
CMessage * | ConstructMessage (int mtid, JS::HandleValue data) |
void | SendGlobalMessage (entity_id_t ent, const CMessage &msg) |
void | FlattenDynamicSubscriptions () |
void | RemoveComponentDynamicSubscriptions (IComponent *component) |
ComponentTypeId | GetScriptWrapper (InterfaceId iid) |
CEntityHandle | AllocateEntityHandle (entity_id_t ent) |
Friends | |
class | TestComponentManager |
|
private |
typedef int CComponentManager::ComponentTypeId |
|
private |
typedef int CComponentManager::InterfaceId |
using CComponentManager::InterfaceList = std::vector<InterfacePair> |
using CComponentManager::InterfaceListUnordered = std::unordered_map<entity_id_t, IComponent*> |
using CComponentManager::InterfacePair = std::pair<entity_id_t, IComponent*> |
typedef int CComponentManager::MessageTypeId |
|
private |
CComponentManager::CComponentManager | ( | CSimContext & | context, |
ScriptContext & | cx, | ||
bool | skipScriptFunctions = false |
||
) |
CComponentManager::~CComponentManager | ( | ) |
bool CComponentManager::AddComponent | ( | CEntityHandle | ent, |
ComponentTypeId | cid, | ||
const CParamNode & | paramNode | ||
) |
Constructs a component of type 'cid', initialised with data 'paramNode', and attaches it to entity 'ent'.
entity_id_t CComponentManager::AddEntity | ( | const std::wstring & | templateName, |
entity_id_t | ent | ||
) |
Constructs an entity based on the given template, and adds it the world with entity ID ent
.
There should not be any existing components with that entity ID.
void CComponentManager::AddMockComponent | ( | CEntityHandle | ent, |
InterfaceId | iid, | ||
IComponent & | component | ||
) |
Adds an externally-created component, so that it is returned by QueryInterface but does not get destroyed and does not receive messages from the component manager.
(This is intended for unit tests that need to add mock objects the tested components expect to exist.)
void CComponentManager::AddSystemComponents | ( | bool | skipScriptedComponents, |
bool | skipAI | ||
) |
Add all system components to the system entity (skip the scripted components or the AI components on demand)
|
private |
entity_id_t CComponentManager::AllocateNewEntity | ( | ) |
Returns a new entity ID that has never been used before.
This affects the simulation state so it must only be called in network-synchronised ways.
entity_id_t CComponentManager::AllocateNewEntity | ( | entity_id_t | preferredId | ) |
Returns a new entity ID that has never been used before.
If possible, returns preferredId, and ensures this ID won't be allocated again. This affects the simulation state so it must only be called in network-synchronised ways.
entity_id_t CComponentManager::AllocateNewLocalEntity | ( | ) |
Returns a new local entity ID that has never been used before.
This entity will not be synchronised over the network, stored in saved games, etc.
void CComponentManager::BroadcastMessage | ( | const CMessage & | msg | ) |
Send a message, not targeted at any particular entity.
The message will be received by any components that subscribed (either globally or not) to the message type.
bool CComponentManager::ComputeStateHash | ( | std::string & | outHash, |
bool | quick | ||
) | const |
IComponent * CComponentManager::ConstructComponent | ( | CEntityHandle | ent, |
ComponentTypeId | cid | ||
) |
Allocates a component object of type 'cid', and attaches it to entity 'ent'.
(The component's Init is not called here - either Init or Deserialize must be called before using the returned object.)
|
private |
bool CComponentManager::DeserializeState | ( | std::istream & | stream | ) |
void CComponentManager::DestroyComponentsSoon | ( | entity_id_t | ent | ) |
Destroys all the components belonging to the specified entity when FlushDestroyedComponents is called.
Has no effect if the entity does not exist, or has already been added to the destruction queue.
bool CComponentManager::DumpDebugState | ( | std::ostream & | stream, |
bool | includeDebugInfo | ||
) | const |
void CComponentManager::DynamicSubscriptionNonsync | ( | MessageTypeId | mtid, |
IComponent * | component, | ||
bool | enabled | ||
) |
Subscribe the given component instance to all messages of the given message type.
The component's HandleMessage will be called on any BroadcastMessage or PostMessage of this message type, regardless of the entity.
This can be called at any time (including inside the HandleMessage callback for this message type).
The component type must not have statically subscribed to this message type in its ClassInit.
The subscription status is not saved or network-synchronised. Components must remember to resubscribe in their Deserialize methods if they still want the message.
This is primarily intended for Interpolate and RenderSubmit messages, to avoid the cost of sending the message to components that do not currently need to do any rendering.
bool CComponentManager::EntityExists | ( | entity_id_t | ent | ) | const |
Returns true if the entity with id ent
exists.
|
private |
void CComponentManager::FlushDestroyedComponents | ( | ) |
Does the actual destruction of components from DestroyComponentsSoon.
This must not be called if the component manager is on the call stack (since it will break internal iterators).
std::string CComponentManager::GenerateSchema | ( | ) | const |
CComponentManager::InterfaceList CComponentManager::GetEntitiesWithInterface | ( | InterfaceId | iid | ) | const |
const CComponentManager::InterfaceListUnordered & CComponentManager::GetEntitiesWithInterfaceUnordered | ( | InterfaceId | iid | ) | const |
|
inline |
|
private |
|
inline |
Returns a CEntityHandle with id SYSTEM_ENTITY.
void CComponentManager::InitSystemEntity | ( | ) |
Set up an empty SYSTEM_ENTITY.
Must be called after ResetState() and before GetSystemEntity().
void CComponentManager::LoadComponentTypes | ( | ) |
bool CComponentManager::LoadScript | ( | const VfsPath & | filename, |
bool | hotload = false |
||
) |
Load a script and execute it in a new function scope.
filename | VFS path to load |
hotload | set to true if this script has been loaded before, and redefinitions of existing components should not be considered errors |
CComponentManager::ComponentTypeId CComponentManager::LookupCID | ( | const std::string & | cname | ) | const |
cname | Requested component type name (not including any "CID" or "CCmp" prefix) |
std::string CComponentManager::LookupComponentTypeName | ( | ComponentTypeId | cid | ) | const |
CEntityHandle CComponentManager::LookupEntityHandle | ( | entity_id_t | ent, |
bool | allowCreate = false |
||
) |
Returns a CEntityHandle with id ent
.
If allowCreate
is true and there is no existing CEntityHandle, a new handle will be allocated.
void CComponentManager::MarkScriptedComponentForSystemEntity | ( | CComponentManager::ComponentTypeId | cid | ) |
|
private |
void CComponentManager::PostMessage | ( | entity_id_t | ent, |
const CMessage & | msg | ||
) |
Send a message, targeted at a particular entity.
The message will be received by any components of that entity which subscribed to the message type, and by any other components that subscribed globally to the message type.
IComponent * CComponentManager::QueryInterface | ( | entity_id_t | ent, |
InterfaceId | iid | ||
) | const |
void CComponentManager::RegisterComponentType | ( | InterfaceId | iid, |
ComponentTypeId | cid, | ||
AllocFunc | alloc, | ||
DeallocFunc | dealloc, | ||
const char * | name, | ||
const std::string & | schema | ||
) |
void CComponentManager::RegisterComponentTypeScriptWrapper | ( | InterfaceId | iid, |
ComponentTypeId | cid, | ||
AllocFunc | alloc, | ||
DeallocFunc | dealloc, | ||
const char * | name, | ||
const std::string & | schema | ||
) |
void CComponentManager::RegisterMessageType | ( | MessageTypeId | mtid, |
const char * | name | ||
) |
|
private |
void CComponentManager::ResetState | ( | ) |
Resets the dynamic simulation state (deletes all entities, resets entity ID counters; doesn't unload/reload component scripts).
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
bool CComponentManager::SerializeState | ( | std::ostream & | stream | ) | const |
void CComponentManager::SetRNGSeed | ( | u32 | seed | ) |
Initializes the random number generator with a seed determined by the host.
void CComponentManager::SubscribeGloballyToMessageType | ( | MessageTypeId | mtid | ) |
Subscribe the current component type to all messages of the given message type.
Each component's HandleMessage will be called on any BroadcastMessage or PostMessage of this message type, regardless of the entity. Must only be called by a component type's ClassInit.
void CComponentManager::SubscribeToMessageType | ( | MessageTypeId | mtid | ) |
Subscribe the current component type to the given message type.
Each component's HandleMessage will be called on any BroadcastMessage of this message type, or on any PostMessage of this type targeted at the component's entity. Must only be called by a component type's ClassInit.
|
friend |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |