Drag[en]gine Script Module DragonScript  1.21
Public Member Functions | Protected Member Functions | List of all members
Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Public Member Functions

void addToGameWorld ()
 Add to game world. More...
 
void dispose ()
 Dispose of composeable instance. More...
 
String getAction ()
 Action to carry out. More...
 
String getCameraSpot ()
 Camera spot to activate when hot-spot is activated. More...
 
float getDelayActivate ()
 Delay for activating IMMProp after hotspot has been activated. More...
 
float getDelayDeactivate ()
 Delay for deactivating IMMProp after hotspot has been deactivated. More...
 
String getDisplayText ()
 Display text. More...
 
String getDisplayTextTranslate ()
 Translated display text or null. More...
 
IMMBehaviorHotSpot getECBehavior ()
 Element class behavior. More...
 
bool getHotSpotActive ()
 Hot-spot is active. More...
 
float getRemainingDelay ()
 Remaing prop (de)activate prop delay. More...
 
TSNamedTriggerTarget getTargetHotSpotActivated ()
 Trigger target to reflect activated state. More...
 
TSNamedTriggerTarget getTargetHotSpotActivating ()
 Trigger target to notify activating. More...
 
TSNamedTriggerTarget getTargetHotSpotDeactivating ()
 Trigger target to notify deactivating. More...
 
TSNamedTriggerTarget getTargetHotSpotEntered ()
 Trigger target to notify entering. More...
 
TSNamedTriggerTarget getTargetHotSpotHover ()
 Trigger target to reflect hovering state. More...
 
TSNamedTriggerTarget getTargetHotSpotLeft ()
 Trigger target to notify leaving. More...
 
float getTransitionTime ()
 Transition time. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (IMMBehaviorHotSpot ecbehavior, BehaviorElement element)
 Create element. More...
 
void onHotSpotActivated ()
 Hot-spot has been activated. More...
 
void onHotSpotDeactivated ()
 Hot-spot has been deactivated. More...
 
void onHotSpotHoverEnter ()
 Mouse pointer is hovering over Hot-spot. More...
 
void onHotSpotHoverExit ()
 Mouse pointer is no more hovering over Hot-spot. More...
 
void removeFromGameWorld ()
 Remove from game world. More...
 
void reset ()
 Reset initial state immediately. More...
 
void setActivated ()
 Set activated now. More...
 
void think (float elapsed)
 Think about what the element is going to do in this frame. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void enterFrame ()
 Frame update started. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior instance from file. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior instance to file. More...
 

Protected Member Functions

void setAction (String action)
 Set action to carry out. More...
 
void setCameraSpot (String cameraSpot)
 Set camera spot to activate when hot-spot is activated. More...
 
void setDelayActivate (float delay)
 Set delay for activating IMMProp after hotspot has been activated. More...
 
void setDelayDeactivate (float delay)
 Set delay for deactivating IMMProp after hotspot has been deactivated. More...
 
void setDisplayText (String text)
 Set display text. More...
 
void setDisplayTextTranslate (String text)
 Set translated display text or null. More...
 
void setRemainingDelay (float time)
 Set remaing prop (de)activate prop delay. More...
 
void setTransitionTime (float time)
 Set transition time. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

Detailed Description

Behavior instance.

Member Function Documentation

◆ addToGameWorld()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.addToGameWorld ( )

Add to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.dispose ( )

Dispose of composeable instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getAction()

String Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getAction ( )

Action to carry out.

◆ getCameraSpot()

String Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getCameraSpot ( )

Camera spot to activate when hot-spot is activated.

◆ getDelayActivate()

float Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getDelayActivate ( )

Delay for activating IMMProp after hotspot has been activated.

◆ getDelayDeactivate()

float Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getDelayDeactivate ( )

Delay for deactivating IMMProp after hotspot has been deactivated.

◆ getDisplayText()

String Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getDisplayText ( )

Display text.

◆ getDisplayTextTranslate()

String Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getDisplayTextTranslate ( )

Translated display text or null.

Version
1.16

◆ getECBehavior()

IMMBehaviorHotSpot Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getECBehavior ( )

Element class behavior.

◆ getHotSpotActive()

bool Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getHotSpotActive ( )

Hot-spot is active.

◆ getRemainingDelay()

float Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getRemainingDelay ( )

Remaing prop (de)activate prop delay.

◆ getTargetHotSpotActivated()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotActivated ( )

Trigger target to reflect activated state.

◆ getTargetHotSpotActivating()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotActivating ( )

Trigger target to notify activating.

◆ getTargetHotSpotDeactivating()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotDeactivating ( )

Trigger target to notify deactivating.

◆ getTargetHotSpotEntered()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotEntered ( )

Trigger target to notify entering.

◆ getTargetHotSpotHover()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotHover ( )

Trigger target to reflect hovering state.

◆ getTargetHotSpotLeft()

TSNamedTriggerTarget Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTargetHotSpotLeft ( )

Trigger target to notify leaving.

◆ getTransitionTime()

float Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.getTransitionTime ( )

Transition time.

◆ init()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.init ( StubElement  stub)

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

Instance Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.new ( IMMBehaviorHotSpot  ecbehavior,
BehaviorElement  element 
)

Create element.

◆ onHotSpotActivated()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.onHotSpotActivated ( )

Hot-spot has been activated.

Hot-spot has to start activate transition (possibly delayed).

◆ onHotSpotDeactivated()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.onHotSpotDeactivated ( )

Hot-spot has been deactivated.

Hot-spot has to stop running the action and start deactivate transition (possibly delayed).

◆ onHotSpotHoverEnter()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.onHotSpotHoverEnter ( )

Mouse pointer is hovering over Hot-spot.

Hot-spot has to start hover actions if present.

◆ onHotSpotHoverExit()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.onHotSpotHoverExit ( )

Mouse pointer is no more hovering over Hot-spot.

Hot-spot has to stop hover actions if present.

◆ removeFromGameWorld()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.removeFromGameWorld ( )

Remove from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ reset()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.reset ( )

Reset initial state immediately.

◆ setAction()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setAction ( String  action)
protected

Set action to carry out.

◆ setActivated()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setActivated ( )

Set activated now.

◆ setCameraSpot()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setCameraSpot ( String  cameraSpot)
protected

Set camera spot to activate when hot-spot is activated.

◆ setDelayActivate()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setDelayActivate ( float  delay)
protected

Set delay for activating IMMProp after hotspot has been activated.

◆ setDelayDeactivate()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setDelayDeactivate ( float  delay)
protected

Set delay for deactivating IMMProp after hotspot has been deactivated.

◆ setDisplayText()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setDisplayText ( String  text)
protected

Set display text.

◆ setDisplayTextTranslate()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setDisplayTextTranslate ( String  text)
protected

Set translated display text or null.

Version
1.16

◆ setRemainingDelay()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setRemainingDelay ( float  time)
protected

Set remaing prop (de)activate prop delay.

◆ setTransitionTime()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.setTransitionTime ( float  time)
protected

Set transition time.

◆ think()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.Instance.think ( float  elapsed)

Think about what the element is going to do in this frame.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

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