iSequenceTrigger Struct Reference
A sequence trigger. More...
#include <engseq.h>
Inheritance diagram for iSequenceTrigger:

Public Methods | |
virtual iObject * | QueryObject ()=0 |
Query object. | |
virtual void | AddConditionInSector (iSector *sector)=0 |
Condition: true if camera is in some sector. | |
virtual void | AddConditionInSector (iSector *sector, const csBox3 &box)=0 |
Condition: true if camera is in some sector and bbox. | |
virtual void | AddConditionInSector (iSector *sector, const csSphere &sphere)=0 |
Condition: true if camera is in some sector and sphere. | |
virtual void | AddConditionSectorVisible (iSector *sector)=0 |
Condition: true if (part of) sector is visible. | |
virtual void | AddConditionMeshClick (iMeshWrapper *mesh)=0 |
Condition: true if clicked on a mesh. | |
virtual void | AddConditionLightChange (iLight *whichlight, int oper, const csColor &color)=0 |
Condition: light change. | |
virtual void | AddConditionManual ()=0 |
Condition: manual trigger. | |
virtual void | SetEnabled (bool en)=0 |
Enable/disable this trigger. | |
virtual bool | IsEnabled () const=0 |
Get enabled/disabled state. | |
virtual void | ClearConditions ()=0 |
Clear all conditions. | |
virtual void | Trigger ()=0 |
Trigger the manual condition. | |
virtual void | SetParameters (iEngineSequenceParameters *params)=0 |
Set the parameter block to use for the sequence when it is fired. | |
virtual iEngineSequenceParameters * | GetParameters () const=0 |
Get the parameter block. | |
virtual void | FireSequence (csTicks delay, iSequenceWrapper *seq)=0 |
Attach the sequence that will be fired when all trigger conditions are valid. | |
virtual iSequenceWrapper * | GetFiredSequence ()=0 |
Get the attached sequence. | |
virtual void | TestConditions (csTicks delay)=0 |
Test the conditions of this trigger every 'delay' milliseconds. | |
virtual bool | CheckState ()=0 |
This function returns true if the trigger conditions are valid. | |
virtual void | ForceFire (bool now=false)=0 |
Force the sequence of this trigger to be fired right now. |
Detailed Description
A sequence trigger.When all conditions in a trigger are true it will run a sequence. Note that after the succesfull firing of a trigger it will automatically be disabled.
Main creators of instances implementing this interface:
Main ways to get pointers to this interface: Main users of this interface:
Definition at line 526 of file engseq.h.
Member Function Documentation
|
Condition: true if camera is in some sector and sphere.
|
|
Condition: true if camera is in some sector and bbox.
|
|
Condition: true if camera is in some sector.
|
|
Condition: light change. Call this to add a trigger which fires a sequence when a light gets darker than a certain value or lighter than a certain value, or whenever a light changes.
|
|
Condition: manual trigger. Call this to set add a trigger that requires manual confirmation. The 'Trigger()' function can then be used later to actually do the trigger. |
|
Condition: true if clicked on a mesh.
|
|
Condition: true if (part of) sector is visible.
|
|
This function returns true if the trigger conditions are valid. This only works if TestConditions() has been called and it doesn't work immediatelly after TestConditions() because TestConditions() needs to take some time before it actually can retest the conditions. |
|
Clear all conditions.
|
|
Attach the sequence that will be fired when all trigger conditions are valid.
|
|
Force the sequence of this trigger to be fired right now. Note that this will even fire if the trigger is disabled and conditions are completely ignored. Also calling ForceFire() will NOT cause the trigger to become disabled (as opposed to when a trigger normally fires). So if you want to make sure the trigger does not accidently fire again right after firing it you should disable the trigger (and possibly let the sequence enable it again). Note that ForceFire() still respects the fire delay with which the sequence was registered. If you use 'now' == true then this delay will be ignored and the sequence will be started immediatelly. |
|
Get the attached sequence.
|
|
Get the parameter block.
|
|
Get enabled/disabled state.
|
|
Query object.
|
|
Enable/disable this trigger. Triggers start enabled by default. |
|
Set the parameter block to use for the sequence when it is fired.
|
|
Test the conditions of this trigger every 'delay' milliseconds. Use this in combination with CheckState(). If 'delay' == 0 then this testing is disabled (default). |
|
Trigger the manual condition.
|
The documentation for this struct was generated from the following file:
- ivaria/engseq.h
Generated for Crystal Space by doxygen 1.2.18