Drag[en]gine Script Module DragonScript Script API  1.0
BaseLight Class Referenceabstract
Inheritance diagram for BaseLight:
Element LightPoint LightSpot

Public Member Functions

void addToGameWorld ()
 
bool getActivated ()
 
void init (StubElement stub)
 
void initLight (StubElement stub)
 
BaseLight new (ElementClass eclass)
 
void readFromFile (FileReader reader)
 
void removeFromGameWorld ()
 
void setActivated (bool activated)
 
void toggle ()
 
void visit (ElementVisitor visitor)
 
void writeToFile (FileWriter writer)
 
- Public Member Functions inherited from Element
void addToGameWorld ()
 
void dispose ()
 
ElementClass getClass ()
 
DMatrix getElementMatrix ()
 Matrix to transform from element space into world space. More...
 
GameWorld getGameWorld ()
 
UniqueID getID ()
 
DMatrix getInverseElementMatrix ()
 Matrix to transform from world space into element space. More...
 
Quaternion getOrientation ()
 
Element getParent ()
 
DVector getPosition ()
 
bool getTouchable ()
 
bool getVisible ()
 
void init (StubElement stub)
 
bool isChildOf (Element parent)
 
bool isMyselfOrChildOf (Element parent)
 
Element new (ElementClass elementClass)
 
void onSetGameWorld ()
 
void onSetGeometry ()
 
void onSetOrientation ()
 
void onSetParent ()
 
void onSetPosition ()
 
void onSetTouchable ()
 
void onSetVisible ()
 
void postLoadInit ()
 
void postThink (float elapsed)
 
void readFromFile (FileReader reader)
 
void removeFromGameWorld ()
 
void removeFromGameWorldIfPresent ()
 Remove element from game world if present. More...
 
void setGameWorld (GameWorld gameWorld)
 
void setGeometry (DVector position, Quaternion orientation)
 
void setID (UniqueID id)
 
void setOrientation (Quaternion orientation)
 
void setParent (Element parent)
 
void setPosition (DVector position)
 
void setTouchable (bool touchable)
 
void setVisible (bool visible)
 
void think (float elapsed)
 
String toString ()
 
void visit (ElementVisitor visitor)
 
void writeToFile (FileWriter writer)
 

Protected Member Functions

Light getLight ()
 

Detailed Description

Basic Light class.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ addToGameWorld()

void addToGameWorld ( )

Adds the element to the game world.

§ getActivated()

bool getActivated ( )

Determines if the light is activated.

§ getLight()

Light getLight ( )
protected

Retrieve the scene light.

§ init()

void init ( StubElement  stub)

Initialize the element from a stub.

§ initLight()

void initLight ( StubElement  stub)

Initialize the light resource using a stub.

§ new()

BaseLight new ( ElementClass  eclass)

Creates a new Light object.

§ readFromFile()

void readFromFile ( FileReader  reader)

Reads the element from a file writer.

§ removeFromGameWorld()

void removeFromGameWorld ( )

Removes the element from the game world if one is set. Does not dispose of the element.

§ setActivated()

void setActivated ( bool  activated)

Sets if the light is activated.

§ toggle()

void toggle ( )

Toggles light on or off.

§ visit()

void visit ( ElementVisitor  visitor)

Visit this element.

§ writeToFile()

void writeToFile ( FileWriter  writer)

Writes the element to a file writer.


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