#include <pseffectobjsound.h>
List of all members.
Detailed Description
Definition at line 32 of file pseffectobjsound.h.
Constructor & Destructor Documentation
| psEffectObjSound::psEffectObjSound |
( |
iView * |
parentView, |
|
|
psEffect2DRenderer * |
renderer2d |
|
) |
| |
| psEffectObjSound::~psEffectObjSound |
( |
| ) |
|
Member Function Documentation
| bool psEffectObjSound::AttachToAnchor |
( |
psEffectAnchor * |
newAnchor | ) |
[virtual] |
Attaches this mesh to the given effect anchor.
- Parameters:
-
| newAnchor | The effect anchor to attach this mesh to. |
- Returns:
- true If it attached properly, false otherwise.
Reimplemented from psEffectObj.
| psEffectObj* psEffectObjSound::Clone |
( |
| ) |
const [virtual] |
Clones the effect object.
This will almost always be overloaded.
Reimplemented from psEffectObj.
| bool psEffectObjSound::Load |
( |
iDocumentNode * |
node, |
|
|
iLoaderContext * |
ldr_context |
|
) |
| [virtual] |
Loads the effect object from an xml node.
- Parameters:
-
| node | the xml node containing the effect object, must be valid |
| ldr_context | the current loader context. |
- Returns:
- true on success, false otherwise
Reimplemented from psEffectObj.
| bool psEffectObjSound::Render |
( |
const csVector3 & |
up | ) |
[virtual] |
Renders the effect.
- Parameters:
-
| up | the base up vector of the effect obj |
- Returns:
- true on success
Reimplemented from psEffectObj.
| bool psEffectObjSound::Update |
( |
csTicks |
elapsed | ) |
[virtual] |
Updates the spell effect -- called every frame.
- Parameters:
-
| elapsed | the ticks elapsed since last update |
- Returns:
- false if the obj is useless and can be removed
Reimplemented from psEffectObj.
The documentation for this class was generated from the following file:
