ComponentBasicsT Class Reference

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

Inheritance diagram for ComponentBasicsT:

Public Attributes
string	Name
	The name of the entity. More...
boolean	Static
	Are the map primitives of this entity fixed and immovable, never moving around in the game world? More...

Additional Inherited Members
Public Member Functions inherited from ComponentBaseT
any	get (string var_name)
	Returns the value of an attribute (a member variable) of this class. More...
	set (string var_name, any new_value)
	Sets an attribute (a member variable) of this class to a new value. More...
string	GetExtraMessage (string var_name)
	Returns the result of VarBaseT::GetExtraMessage() for the given member variable. More...
	interpolate (string var_name, number start_value, number end_value, number time)
	Schedules a value for interpolation between a start and end value over a given period of time. More...
EntityT	GetEntity ()
	Returns the entity that this component is a part of (or nil if the component is currently "stand-alone", not a part of any entity). More...
	InitClientApprox (string VarName)
	Registers the given attribute (a member variable) of this class for interpolation over client frames in order to bridge the larger intervals between server frames. More...
	OnInit ()
	This method is called for each component of each entity as the last step of initializing a newly loaded map. More...
	OnClientFrame (number t)
	This method is called for each component of each entity before the client renders the next frame. More...

Detailed Description

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

Note that the variables of this class (also referred to as "Public Attributes" or "Member Data") must be used with the get() and set() methods at this time – see get() and set() for details.

If you would like to create a new component of this type explicitly (those defined in the CaWE Map Editor are instantiated automatically), use WorldT::new():

local comp = world:new("ComponentBasicsT")

Implementing C++ Class:

cf::GameSys::ComponentBasicsT

Member Data Documentation

string Name

The name of the entity.

Entity names must be valid Lua script identifiers and unique among their siblings.

Related C++ type:

std::string

boolean Static

Are the map primitives of this entity fixed and immovable, never moving around in the game world?

Related C++ type:

bool