---

LightPuppet Class Reference

Puppet type for a light. More...

#include <puppet.h>

Inheritance diagram for LightPuppet::

List of all members.

Public Methods
	LightPuppet (vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo)
	XML File-based constructor. More...
void	KeyframeAnimation (uint16 anim)
	Does nothing in LightPuppet. More...
uint16	PuppetType (void)
	Returns a code identifying the type of puppet. More...
void	UpdateTick (void)
	Function that gets called on a puppet every update. More...

---

Detailed Description

Puppet type for a light.

LightPuppet controls all aspects of a dynamic light in the engine, and can can only PropertyJoints to control its color, intensity and position.

---

Constructor & Destructor Documentation

LightPuppet::LightPuppet (  vpmVPM *    vpmPuppetInfo, ssfPuppet *    ssfPuppetInfo, VPM *    vpmFileInfo )

XML File-based constructor. Parameters: vpmPuppetInfo  an XML parse file from the .vpm detailing a specific puppet. ssfPuppetInfo  an XML parse file from the .ssf detailing a specific puppet. vpmFileInfo  an XML parse file from the .vpm detailing an entire file. This constructor creates a puppet according to the parse files provided by the stage.

---

Member Function Documentation

LightPuppet::KeyframeAnimation (  uint16    anim )  [virtual]

Does nothing in LightPuppet. Parameters: anim  an integer specifying the animation to start. In LightPuppet, KeyframeAnimation is useless, thought the concept of "light animation" might be an idea to explore in the future. Reimplemented from Puppet.

uint16 LightPuppet::PuppetType (  void    )  [virtual]

Returns a code identifying the type of puppet. Returns: the puppet code Reimplemented from Puppet.

void LightPuppet::UpdateTick (  void    )  [virtual]

Function that gets called on a puppet every update. If a puppet requires maintenance or upkeep of some sort, changing data only when the Stage recieves a network packet from Kairaishi might not be sufficient. Every update tick, this function gets called to remedy that problem. Reimplemented from Puppet.

---

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

• puppet.h

---