Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Classes

class  PlayerTakesControl
 Player takes control listener. More...
 

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void dispose ()
 Dispose of instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
int getBindingIconHeight ()
 Binding icon height. More...
 
ECPInteger getBindingIconHeight ()
 Binding icon height. More...
 
BindingManager getBindingManager ()
 Binding manager or null. More...
 
CommandManager getCommandManager ()
 Command manager or null. More...
 
ECBehaviorPlayerInteractPrompt getECBehavior ()
 Behavior. More...
 
bool getEnabled ()
 Behavior is enabled showing interact prompts if an element is looked at. More...
 
ECBehaviorPlayerControllable.Instance getPlayerControllable ()
 Player controllable behavior. More...
 
ECBehaviorPlayerControllable getPlayerControllable ()
 Player controllable behavior. More...
 
PromptController getPromptController ()
 Prompt controller or null if not created. More...
 
PromptControllerFactory getPromptControllerFactory ()
 Prompt controller factory. More...
 
Array getPromptsFrom (BehaviorElement element)
 Get prompts to shows as Array of ECBehaviorInteractPrompt.Instance. More...
 
float getTransparency ()
 Transparency. More...
 
ECPFloat getTransparency ()
 Transparency. More...
 
Container getUIContainer ()
 UI Container to add panel to. More...
 
Container getUIContainer ()
 UI Container to add panel to. More...
 
Object getUIContainerAddSettings ()
 Settings use to add prompt widget to UI Container. More...
 
bool getVisibleIfEmpty ()
 Show prompt widget if no prompts are present. More...
 
ECPBoolean getVisibleIfEmpty ()
 Show prompt widget if no prompts are present. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings)
 Create behavior element class. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, CommandManager commandManager, BindingManager bindingManager)
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, CommandManager commandManager, BindingManager bindingManager, String prefix)
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, String prefix)
 
Instance new (ECBehaviorPlayerInteractPrompt ecbehavior, BehaviorElement element)
 Create instance. More...
 
void playerReleasesControl ()
 Player released control. More...
 
void playerTakesControl ()
 Player takes control. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setBindingManager (BindingManager bindingManager)
 Set binding manager or null. More...
 
void setCommandManager (CommandManager commandManager)
 Set command manager or null. More...
 
void setEnabled (bool enabled)
 Set if behavior is enabled showing interact prompts if an element is looked at. More...
 
void setPromptControllerFactory (PromptControllerFactory factory)
 Set prompt controller factory. More...
 
void setTransparency (float transparency)
 Set transparency. More...
 
void setUIContainer (Container container)
 Set UI container to add panel to. More...
 
void setUIContainer (Container container)
 Set UI Container to add panel to. More...
 
void setUIContainerAddSettings (Object settings)
 Set settings use to add prompt widget to UI Container. More...
 
void setVisibleIfEmpty (bool visible)
 Set if prompt widget is visible if no prompts are present. More...
 
void updatePrompts ()
 Update prompts. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void addToGameWorld ()
 Add element to game world. More...
 
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...
 
void removeFromGameWorld ()
 Remove element from game world. 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 think (float elapsed)
 Think about what to do for the next frame update. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior instance to file. More...
 

Static Public Member Functions

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

Public Attributes

int pBindingIconHeight
 
ECPInteger pBindingIconHeight
 
BindingManager pBindingManager
 
CommandManager pCommandManager
 
ECBehaviorPlayerInteractPrompt pECBehavior
 
bool pEnabled
 
Array pListenerFactories
 
Array pListeners
 
ECBehaviorPlayerControllable.Instance pPlayerControllable
 
ECBehaviorPlayerControllable pPlayerControllable
 
PromptController pPromptController
 
PromptControllerFactory pPromptControllerFactory
 
float pTransparency
 
ECPFloat pTransparency
 
Container pUIContainer
 
Object pUIContainerAddSettings
 
bool pVisibleIfEmpty
 
ECPBoolean pVisibleIfEmpty
 

Additional Inherited Members

- 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

◆ addListener()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.addListener ( Listener  listener)

Add listener.

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createListeners()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ dispose() [1/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.dispose ( )

Dispose of instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose() [2/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

static ECBehaviorPlayerInteractPrompt Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.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 ECBehaviorPlayerInteractPrompt.

◆ getBindingIconHeight() [1/2]

int Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getBindingIconHeight ( )

Binding icon height.

◆ getBindingIconHeight() [2/2]

ECPInteger Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getBindingIconHeight ( )

Binding icon height.

◆ getBindingManager()

BindingManager Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getBindingManager ( )

Binding manager or null.

◆ getCommandManager()

CommandManager Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getCommandManager ( )

Command manager or null.

◆ getECBehavior()

ECBehaviorPlayerInteractPrompt Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getECBehavior ( )

Behavior.

◆ getEnabled()

bool Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getEnabled ( )

Behavior is enabled showing interact prompts if an element is looked at.

◆ getPlayerControllable() [1/2]

ECBehaviorPlayerControllable.Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getPlayerControllable ( )

Player controllable behavior.

◆ getPlayerControllable() [2/2]

ECBehaviorPlayerControllable Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getPlayerControllable ( )

Player controllable behavior.

◆ getPromptController()

PromptController Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getPromptController ( )

Prompt controller or null if not created.

◆ getPromptControllerFactory()

PromptControllerFactory Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getPromptControllerFactory ( )

Prompt controller factory.

◆ getPromptsFrom()

Array Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getPromptsFrom ( BehaviorElement  element)

Get prompts to shows as Array of ECBehaviorInteractPrompt.Instance.

Default implementation gets all enabled instances.

◆ getTransparency() [1/2]

float Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getTransparency ( )

Transparency.

◆ getTransparency() [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getTransparency ( )

Transparency.

◆ getUIContainer() [1/2]

Container Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getUIContainer ( )

UI Container to add panel to.

◆ getUIContainer() [2/2]

Container Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getUIContainer ( )

UI Container to add panel to.

◆ getUIContainerAddSettings()

Object Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getUIContainerAddSettings ( )

Settings use to add prompt widget to UI Container.

◆ getVisibleIfEmpty() [1/2]

bool Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getVisibleIfEmpty ( )

Show prompt widget if no prompts are present.

Version
1.19

◆ getVisibleIfEmpty() [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.getVisibleIfEmpty ( )

Show prompt widget if no prompts are present.

Version
1.19

◆ init()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.init ( StubElement  stub)

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new() [1/5]

Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorPlayerControllable  playerControllable,
PromptControllerFactory  promptControllerFactory,
Container  uiContainer,
Object  uiContainerAddSettings 
)

Create behavior element class.

These parameters can be null:

  • commandManager
  • bindingManager
  • uiContainerAddSettings

◆ new() [2/5]

Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorPlayerControllable  playerControllable,
PromptControllerFactory  promptControllerFactory,
Container  uiContainer,
Object  uiContainerAddSettings,
CommandManager  commandManager,
BindingManager  bindingManager 
)

◆ new() [3/5]

Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorPlayerControllable  playerControllable,
PromptControllerFactory  promptControllerFactory,
Container  uiContainer,
Object  uiContainerAddSettings,
CommandManager  commandManager,
BindingManager  bindingManager,
String  prefix 
)

◆ new() [4/5]

Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorPlayerControllable  playerControllable,
PromptControllerFactory  promptControllerFactory,
Container  uiContainer,
Object  uiContainerAddSettings,
String  prefix 
)

◆ new() [5/5]

Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.new ( ECBehaviorPlayerInteractPrompt  ecbehavior,
BehaviorElement  element 
)

Create instance.

◆ playerReleasesControl()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.playerReleasesControl ( )

Player released control.

Destroys prompt widget if created removing it from the UI container.

◆ playerTakesControl()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.playerTakesControl ( )

Player takes control.

Creates prompt widget if not created already and adds it to UI container.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.removeListener ( Listener  listener)

Remove listener.

◆ setBindingManager()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setBindingManager ( BindingManager  bindingManager)

Set binding manager or null.

◆ setCommandManager()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setCommandManager ( CommandManager  commandManager)

Set command manager or null.

◆ setEnabled()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setEnabled ( bool  enabled)

Set if behavior is enabled showing interact prompts if an element is looked at.

◆ setPromptControllerFactory()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setPromptControllerFactory ( PromptControllerFactory  factory)

Set prompt controller factory.

◆ setTransparency()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setTransparency ( float  transparency)

Set transparency.

◆ setUIContainer() [1/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setUIContainer ( Container  container)

Set UI container to add panel to.

◆ setUIContainer() [2/2]

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setUIContainer ( Container  container)

Set UI Container to add panel to.

◆ setUIContainerAddSettings()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setUIContainerAddSettings ( Object  settings)

Set settings use to add prompt widget to UI Container.

◆ setVisibleIfEmpty()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.setVisibleIfEmpty ( bool  visible)

Set if prompt widget is visible if no prompts are present.

Version
1.19

◆ updatePrompts()

void Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.updatePrompts ( )

Update prompts.

Member Data Documentation

◆ pBindingIconHeight [1/2]

int Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pBindingIconHeight

◆ pBindingIconHeight [2/2]

ECPInteger Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pBindingIconHeight

◆ pBindingManager

BindingManager Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pBindingManager

◆ pCommandManager

CommandManager Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pCommandManager

◆ pECBehavior

ECBehaviorPlayerInteractPrompt Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pECBehavior

◆ pEnabled

bool Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pEnabled

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pListenerFactories

◆ pListeners

Array Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pListeners

◆ pPlayerControllable [1/2]

ECBehaviorPlayerControllable.Instance Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pPlayerControllable

◆ pPlayerControllable [2/2]

ECBehaviorPlayerControllable Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pPlayerControllable

◆ pPromptController

PromptController Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pPromptController

◆ pPromptControllerFactory

PromptControllerFactory Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pPromptControllerFactory

◆ pTransparency [1/2]

float Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pTransparency

◆ pTransparency [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pTransparency

◆ pUIContainer

Container Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pUIContainer

◆ pUIContainerAddSettings

Object Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pUIContainerAddSettings

◆ pVisibleIfEmpty [1/2]

bool Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pVisibleIfEmpty

◆ pVisibleIfEmpty [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorPlayerInteractPrompt.Instance.pVisibleIfEmpty

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