Cafu Engine
cf::GameSys::EntityCreateParamsT Class Reference

Creation parameters for a game entity. More...

#include "EntityCreateParams.hpp"

Inheritance diagram for cf::GameSys::EntityCreateParamsT:

Public Member Functions

 EntityCreateParamsT (WorldT &World_)
 The constructor. More...
 
void ForceID (unsigned int ID)
 This method is used on the client to create entities with the ID sent from the server, not the automatically created ID that would otherwise (normally) be used. More...
 
unsigned int GetID () const
 Returns the "forced" ID that is to be used for the new entity, or UINT_MAX if the normal ID should be used. More...
 

Public Attributes

WorldTWorld
 The world in which the entity should be created. More...
 

Detailed Description

Creation parameters for a game entity.

Constructor & Destructor Documentation

EntityCreateParamsT::EntityCreateParamsT ( WorldT World_)

The constructor.

Parameters
World_The world in which the entity should be created.

Member Function Documentation

void EntityCreateParamsT::ForceID ( unsigned int  ID)

This method is used on the client to create entities with the ID sent from the server, not the automatically created ID that would otherwise (normally) be used.

unsigned int cf::GameSys::EntityCreateParamsT::GetID ( ) const
inline

Returns the "forced" ID that is to be used for the new entity, or UINT_MAX if the normal ID should be used.

Member Data Documentation

WorldT& cf::GameSys::EntityCreateParamsT::World

The world in which the entity should be created.


The documentation for this class was generated from the following files: