ComponentPointLightT Class Reference

This component adds a dynamic point light source to its entity. More...

Inheritance diagram for ComponentPointLightT:

Public Attributes
boolean	On
	Switch the light source on or off. More...
tuple	Color
	The color of the emitted light. More...
number	Radius
	The distance up to which the light may be perceived. More...
number	ShadowType
	The type of the shadows that are cast by this light source. 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 a dynamic point light source to its entity.

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("ComponentPointLightT")

Implementing C++ Class:

cf::GameSys::ComponentPointLightT

Member Data Documentation

tuple Color

The color of the emitted light.

Related C++ type:

Vector3fT

boolean On

Switch the light source on or off.

Related C++ type:

bool

number Radius

The distance up to which the light may be perceived.

Related C++ type:

float

number ShadowType

The type of the shadows that are cast by this light source.

Typical values:

Value	Description
0	none
1	Stencil (hard)

Related C++ type:

int