Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot Class Reference

Behavior element behavior adding interactive main menu hot spot support. More...

Inheritance diagram for Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

void dispose ()
 Dispose of behavior. More...
 
ECPString getAction ()
 
ECBehaviorTwoStateAnimated getAnimated ()
 
ECPString getCameraSpot ()
 
ECPFloat getDelayActivate ()
 
ECPFloat getDelayDeactivate ()
 
ECPString getDisplayText ()
 
ECPString getDisplayTextTranslate ()
 Translated display text. More...
 
ECPString getTargetHotSpotActivated ()
 
ECPString getTargetHotSpotActive ()
 
ECPString getTargetHotSpotDeactivated ()
 
ECPString getTargetHotSpotEntered ()
 
ECPString getTargetHotSpotHover ()
 
ECPString getTargetHotSpotLeft ()
 
IMMTextDisplay getTextDisplay ()
 Text display or null if not used. More...
 
ECPFloat getTransitionTime ()
 
TSTriggerTable getTriggerTable ()
 Trigger table or null if not used. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
IMMBehaviorHotSpot new (BehaviorElementClass eclass, ECBehaviorTwoStateAnimated animated)
 Create behavior element class. More...
 
IMMBehaviorHotSpot new (BehaviorElementClass eclass, ECBehaviorTwoStateAnimated animated, Loaders loaders, TSTriggerTable triggerTable)
 Create behavior element class. More...
 
IMMBehaviorHotSpot new (BehaviorElementClass eclass, ECBehaviorTwoStateAnimated animated, Loaders loaders, TSTriggerTable triggerTable, String prefix)
 
void setTextDisplay (IMMTextDisplay textDisplay)
 Set text display or null if not used. More...
 
void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table or null if not used. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

static IMMBehaviorHotSpot getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior element behavior adding interactive main menu hot spot support.

Member Function Documentation

◆ dispose()

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

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getAction()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getAction ( )

◆ getAnimated()

ECBehaviorTwoStateAnimated Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getAnimated ( )

◆ getBehaviorIn()

static IMMBehaviorHotSpot Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getBehaviorIn ( BehaviorElementClass  eclass)
static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.

◆ getCameraSpot()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getCameraSpot ( )

◆ getDelayActivate()

ECPFloat Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getDelayActivate ( )

◆ getDelayDeactivate()

ECPFloat Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getDelayDeactivate ( )

◆ getDisplayText()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getDisplayText ( )

◆ getDisplayTextTranslate()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getDisplayTextTranslate ( )

Translated display text.

Version
1.16

◆ getTargetHotSpotActivated()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotActivated ( )

◆ getTargetHotSpotActive()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotActive ( )

◆ getTargetHotSpotDeactivated()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotDeactivated ( )

◆ getTargetHotSpotEntered()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotEntered ( )

◆ getTargetHotSpotHover()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotHover ( )

◆ getTargetHotSpotLeft()

ECPString Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTargetHotSpotLeft ( )

◆ getTextDisplay()

IMMTextDisplay Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTextDisplay ( )

Text display or null if not used.

◆ getTransitionTime()

ECPFloat Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTransitionTime ( )

◆ getTriggerTable()

TSTriggerTable Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.getTriggerTable ( )

Trigger table or null if not used.

◆ instance()

Instance Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.instance ( BehaviorElement  element)

Get instance in element from owner element class.

◆ new() [1/3]

IMMBehaviorHotSpot Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.new ( BehaviorElementClass  eclass,
ECBehaviorTwoStateAnimated  animated 
)

Create behavior element class.

◆ new() [2/3]

IMMBehaviorHotSpot Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.new ( BehaviorElementClass  eclass,
ECBehaviorTwoStateAnimated  animated,
Loaders  loaders,
TSTriggerTable  triggerTable 
)

Create behavior element class.

◆ new() [3/3]

IMMBehaviorHotSpot Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.new ( BehaviorElementClass  eclass,
ECBehaviorTwoStateAnimated  animated,
Loaders  loaders,
TSTriggerTable  triggerTable,
String  prefix 
)

◆ setTextDisplay()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.setTextDisplay ( IMMTextDisplay  textDisplay)

Set text display or null if not used.

◆ setTriggerTable()

void Dragengine.Gui.MainMenus.Interactive.IMMBehaviorHotSpot.setTriggerTable ( TSTriggerTable  triggerTable)

Set trigger table or null if not used.


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