This component adds the basics of the entity (its name and the "is shown?" flag). More...

#include "CompBasics.hpp"

Inheritance diagram for cf::GameSys::ComponentBasicsT:

Public Member Functions
	ComponentBasicsT ()
	The constructor. More...

	ComponentBasicsT (const ComponentBasicsT &Comp)
	The copy constructor. More...

const std::string &	GetEntityName () const
	Returns the name of the entity. More...

void	SetEntityName (const std::string &Name)
	Sets a new name for the entity. More...

bool	IsStatic () const
	Returns `true` if the entity is declared as static. Returns `false` if (the primitives of) the entity can move. More...

ComponentBasicsT *	Clone () const override
	The virtual copy constructor. More...

const char *	GetName () const override
	Returns the name of this component. More...

const cf::TypeSys::TypeInfoT *	GetType () const

Public Member Functions inherited from cf::GameSys::ComponentBaseT
	ComponentBaseT ()
	The constructor. More...

	ComponentBaseT (const ComponentBaseT &Comp)
	The copy constructor. More...

virtual	~ComponentBaseT ()
	The virtual destructor. More...

EntityT *	GetEntity () const
	Returns the parent entity that contains this component, or `NULL` if this component is currently not a part of any entity. More...

TypeSys::VarManT &	GetMemberVars ()
	Returns the variable manager that keeps generic references to our member variables, providing a simple kind of "reflection" or "type introspection" feature. More...

template<class T >
void	SetMember (const char *Name, const T &Value)
	Sets the member variable with the given name to the given value. More...

ArrayT< ApproxBaseT * > &	GetInterpolators ()
	Returns the interpolators that have been registered with this component. More...

bool	InitClientApprox (const char *VarName)
	Registers the member variable with the given name for interpolation over client frames in order to bridge the larger intervals between server frames. More...

void	Serialize (cf::Network::OutStreamT &Stream) const
	Writes the current state of this component into the given stream. More...

void	Deserialize (cf::Network::InStreamT &Stream, bool IsIniting)
	Reads the state of this component from the given stream, and updates the component accordingly. More...

bool	CallLuaMethod (const char MethodName, int NumExtraArgs, const char Signature="",...)
	Calls the given Lua method of this component. More...

virtual void	UpdateDependencies (EntityT *Entity)
	This method is called whenever something "external" to this component has changed: More...

virtual unsigned int	GetEditorColor () const
	Returns a color that the Map Editor can use to render the representation of this component's entity. More...

virtual BoundingBox3fT	GetEditorBB () const
	Returns a bounding-box that the Map Editor can use to render the representation of this component's entity and for related hit tests in the 2D and 3D views after mouse clicks. More...

virtual BoundingBox3fT	GetCullingBB () const
	This method returns a bounding-box that encloses the visual representation of this component. More...

virtual const cf::ClipSys::ClipModelT *	GetClipModel ()
	This method returns the clip model of this component, if any. More...

virtual void	PreCache ()
	Initializes any resources that may be needed on the client or server ahead of time. More...

virtual bool	Render (bool FirstPersonView, float LodDist) const
	This method implements the graphical output of this component. More...

virtual void	PostRender (bool FirstPersonView)
	This method provides an opportunity for another render pass. More...

virtual void	OnPostLoad (bool OnlyStatic)
	This method is called after all entities and their components have been loaded. More...

virtual bool	OnInputEvent (const CaKeyboardEventT &KE)
	This method handles keyboard input events. More...

virtual bool	OnInputEvent (const CaMouseEventT &ME, float PosX, float PosY)
	This method handles mouse input events. More...

void	OnServerFrame (float t)
	Advances the component one frame (one "clock-tick") on the server. More...

void	OnClientFrame (float t)
	Advances the component one frame (one "clock-tick") on the client. More...

Public Member Functions inherited from RefCountedT
unsigned int	GetRefCount () const

Static Public Member Functions
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Member Functions inherited from cf::GameSys::ComponentBaseT
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Attributes
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Public Attributes inherited from cf::GameSys::ComponentBaseT
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Protected Member Functions
static int	toString (lua_State *LuaState)

Static Protected Member Functions inherited from cf::GameSys::ComponentBaseT
static int	Get (lua_State *LuaState)

static int	Set (lua_State *LuaState)

static int	GetExtraMessage (lua_State *LuaState)

static int	Interpolate (lua_State *LuaState)

static int	GetEntity (lua_State *LuaState)

static int	InitClientApprox (lua_State *LuaState)

static int	toString (lua_State *LuaState)

Static Protected Attributes
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...

static const char *	DocClass

static const cf::TypeSys::MethsDocT	DocMethods []

static const cf::TypeSys::VarsDocT	DocVars []

Static Protected Attributes inherited from cf::GameSys::ComponentBaseT
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...

static const char *	DocClass

static const cf::TypeSys::MethsDocT	DocMethods []

static const cf::TypeSys::MethsDocT	DocCallbacks []

Additional Inherited Members
Protected Member Functions inherited from RefCountedT
	RefCountedT (const RefCountedT &)

RefCountedT &	operator= (const RefCountedT &)

Detailed Description

This component adds the basics of the entity (its name and the "is shown?" flag).

It is one of the components that is "fundamental" to an entity (cf::GameSys::IsFundamental() returns true). Every entity must have exactly one.

Constructor & Destructor Documentation

ComponentBasicsT::ComponentBasicsT ( )

The constructor.

ComponentBasicsT::ComponentBasicsT ( const ComponentBasicsT & Comp )

The copy constructor.

Parameters

Comp	The component to create a copy of.

Member Function Documentation

ComponentBasicsT * ComponentBasicsT::Clone ( ) const

overridevirtual

The virtual copy constructor.

Callers can use this method to create a copy of this component without knowing its concrete type. Overrides in derived classes use a covariant return type to facilitate use when the concrete type is known. The newly cloned component is initially not a part of any entity, even if the source component was.

Reimplemented from cf::GameSys::ComponentBaseT.

const std::string& cf::GameSys::ComponentBasicsT::GetEntityName ( ) const

inline

Returns the name of the entity.

const char* cf::GameSys::ComponentBasicsT::GetName ( ) const

inlineoverridevirtual

Returns the name of this component.

Reimplemented from cf::GameSys::ComponentBaseT.

bool cf::GameSys::ComponentBasicsT::IsStatic ( ) const

inline

Returns true if the entity is declared as static. Returns false if (the primitives of) the entity can move.

void cf::GameSys::ComponentBasicsT::SetEntityName ( const std::string & Name )

inline

Sets a new name for the entity.

Entity names must be valid Lua script identifiers and unique among their siblings, and the method modifies the given string as necessary. As a result, GetEntityName() can return a string that is different from the string given to a preceeding call to SetEntityName(). This is equivalent to calling SetMember("Name", Name);, but is provided for the more explicit documentation of the side-effects.

Member Data Documentation

const char * ComponentBasicsT::DocClass

staticprotected

Initial value:

=

"This component adds the basic details of the entity (its name, the \"is static?\" flag, Map Editor data)."

const cf::TypeSys::MethsDocT ComponentBasicsT::DocMethods

staticprotected

Initial value:

=
{
    META_toString,
    { NULL, NULL, NULL, NULL }
}

const cf::TypeSys::VarsDocT ComponentBasicsT::DocVars

staticprotected

Initial value:

=
{
    { "Name",    "The name of the entity. Entity names must be valid Lua script identifiers and unique among their siblings." },
    { "Static",  "Are the map primitives of this entity fixed and immovable, never moving around in the game world?" },
    { NULL, NULL }
}

const luaL_Reg ComponentBasicsT::MethodsList

staticprotected

Initial value:

=
{
    { "__tostring", toString },
    { NULL, NULL }
}

The list of Lua methods for this class.

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

Libs/GameSys/CompBasics.hpp
Libs/GameSys/CompBasics.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation