|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.cult3d.world.CultEvent
This class provides a Java representation for a Manual Event that has been created in the Cult3D Designer.
Constructor Summary | |
CultEvent(java.lang.String name)
Constructs a Java representation of a Manual Event defined in the Cult3D Designer. |
Method Summary | |
void |
activate()
Activates the Manual Event this object represents. |
void |
deactivate()
Deactivates the Manual Event this object represents. |
java.lang.String |
getInfo()
Returns a string representation of the values of this object. |
java.lang.String |
getName()
Gets the name of this Cult Event |
boolean |
isActive()
This method lets you know if an Manual event is active. |
java.lang.String |
toString()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D. |
void |
trigger()
Triggers the Manual Event this object represents, triggers always an event even the deactived. |
boolean |
trigger(boolean force)
Triggers the Manual Event this object represents. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public CultEvent(java.lang.String name)
name
- the name of the event.Method Detail |
public java.lang.String getName()
public void trigger()
public boolean trigger(boolean force)
force
- Set to true if you want to trigger an activated/deactived event, set to false if you do not want to
trigger an deactivated event.public void activate()
public void deactivate()
public boolean isActive()
public java.lang.String getInfo()
Returns a string representation of the values of this object.
It returns the name of the CultEvent, and if the CultEvent is active.
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D.
public java.lang.String toString()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |