Public API Reference

iPcLight Struct Reference

This is a property class holding the representation of a light. More...

#include <propclass/light.h>

Inheritance diagram for iPcLight:

List of all members.

Public Member Functions

virtual iLightCreateLight (const char *lightname, iSector *sector, const csVector3 &pos, float radius, const csColor &color)=0
 Create a light with a given name.
virtual iLightGetLight () 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.light.action.' if you want to access this action through a message):

Definition at line 50 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:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1