iPcLight Struct Reference
This is a property class holding the representation of a light. More...
#include <propclass/light.h>
Inheritance diagram for iPcLight:

Public Member Functions | |
virtual iLight * | CreateLight (const char *lightname, iSector *sector, const csVector3 &pos, float radius, const csColor &color)=0 |
Create a light with a given name. | |
virtual iLight * | GetLight () const =0 |
Get the light. | |
virtual void | SetLight (iLight *light)=0 |
Set the light directly. | |
virtual bool | SetLight (const char *lightname)=0 |
Set the light by name. |
Detailed Description
This is a property class holding the representation of a light.
This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- SetLight: parameters 'name' (string). This sets an already existing light for this pclight.
- CreateLight: parameters 'name' (string), 'sector' (string: optional), 'pos' (vector3), 'radius' (float), and 'color' (color). Creates a light for this pclight.
- ChangeColor: parameters 'color' (color). Change color of the light.
- MoveLight: parameters 'pos' (vector3), 'sector' (string: optional). Move a light.
- ParentMesh: parameters 'entity' (string) and 'tag' (string). Parent this light to some parent. The parent should be given as an entity with the optional tag specifying which pcmesh to use. If entity is not given then the current entity will be used.
- ClearParent: no parameters. Remove this light from its parent.
Definition at line 51 of file light.h.
Member Function Documentation
virtual iLight* iPcLight::CreateLight | ( | const char * | lightname, | |
iSector * | sector, | |||
const csVector3 & | pos, | |||
float | radius, | |||
const csColor & | color | |||
) | [pure virtual] |
Create a light with a given name.
Sector can be 0.
virtual iLight* iPcLight::GetLight | ( | ) | const [pure virtual] |
Get the light.
virtual void iPcLight::SetLight | ( | iLight * | light | ) | [pure virtual] |
Set the light directly.
virtual bool iPcLight::SetLight | ( | const char * | lightname | ) | [pure virtual] |
Set the light by name.
Returns false if the light cannot be found.
The documentation for this struct was generated from the following file:
- propclass/light.h
Generated for CEL: Crystal Entity Layer 1.4.1 by doxygen 1.7.1