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

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.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...
 
ECBehaviorPlayerLookAtInteractPrompt getECBehavior ()
 Behavior. More...
 
bool getEnabled ()
 Behavior is enabled showing interact prompts if an element is looked at. More...
 
ECBehaviorLookAt.Instance getLookAt ()
 Look-at behavior. More...
 
ECBehaviorLookAt getLookAt ()
 Look-at behavior. 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, ECBehaviorLookAt lookAt, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, CommandManager commandManager, BindingManager bindingManager)
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, ECBehaviorLookAt lookAt, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, CommandManager commandManager, BindingManager bindingManager, String prefix)
 
Instance new (BehaviorElementClass eclass, ECBehaviorPlayerControllable playerControllable, ECBehaviorLookAt lookAt, PromptControllerFactory promptControllerFactory, Container uiContainer, Object uiContainerAddSettings, String prefix)
 
Instance new (ECBehaviorPlayerLookAtInteractPrompt 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...
 
- 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 ECBehaviorPlayerLookAtInteractPrompt getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

int pBindingIconHeight
 
ECBehaviorPlayerLookAtInteractPrompt pECBehavior
 
bool pEnabled
 
Array pListeners
 
ECBehaviorLookAt.Instance pLookAt
 
ECBehaviorPlayerControllable.Instance pPlayerControllable
 
PromptController pPromptController
 
float pTransparency
 
Container pUIContainer
 
bool 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.ECBehaviorPlayerLookAtInteractPrompt.Instance.addListener ( Listener  listener)

Add listener.

◆ addListenerFactory() [1/2]

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

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

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

Add listener factory.

◆ createListeners()

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

Create listeners from factories adding them to behavior instance.

◆ dispose() [1/2]

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

Dispose of instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose() [2/2]

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

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ forEachListenerFactory()

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

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

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

◆ getBindingIconHeight() [1/2]

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

Binding icon height.

◆ getBindingIconHeight() [2/2]

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

Binding icon height.

◆ getBindingManager()

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

Binding manager or null.

◆ getCommandManager()

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

Command manager or null.

◆ getECBehavior()

ECBehaviorPlayerLookAtInteractPrompt Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.getECBehavior ( )

Behavior.

◆ getEnabled()

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

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

◆ getLookAt() [1/2]

ECBehaviorLookAt.Instance Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.getLookAt ( )

Look-at behavior.

◆ getLookAt() [2/2]

ECBehaviorLookAt Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.getLookAt ( )

Look-at behavior.

◆ getPlayerControllable() [1/2]

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

Player controllable behavior.

◆ getPlayerControllable() [2/2]

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

Player controllable behavior.

◆ getPromptController()

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

Prompt controller or null if not created.

◆ getPromptControllerFactory()

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

Prompt controller factory.

◆ getPromptsFrom()

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

Get prompts to shows as Array of ECBehaviorInteractPrompt.Instance.

Default implementation gets all enabled instances which are closer than the maximum distance set for each interact prompt. If look-at bone name is also present ignores instances having bones defined where the look-at bone is not part of the bones list.

◆ getTransparency() [1/2]

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

Transparency.

◆ getTransparency() [2/2]

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

Transparency.

◆ getUIContainer() [1/2]

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

UI Container to add panel to.

◆ getUIContainer() [2/2]

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

UI Container to add panel to.

◆ getUIContainerAddSettings()

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

Settings use to add prompt widget to UI Container.

◆ getVisibleIfEmpty() [1/2]

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

Show prompt widget if no prompts are present.

Version
1.19

◆ getVisibleIfEmpty() [2/2]

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

Show prompt widget if no prompts are present.

Version
1.19

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new() [1/4]

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

◆ new() [2/4]

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

◆ new() [3/4]

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

◆ new() [4/4]

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

Create instance.

◆ playerReleasesControl()

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

Player released control.

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

◆ playerTakesControl()

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

Player takes control.

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

◆ removeListener()

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

Remove listener.

◆ setBindingManager()

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

Set binding manager or null.

◆ setCommandManager()

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

Set command manager or null.

◆ setEnabled()

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

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

◆ setPromptControllerFactory()

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

Set prompt controller factory.

◆ setTransparency()

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

Set transparency.

◆ setUIContainer() [1/2]

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

Set UI container to add panel to.

◆ setUIContainer() [2/2]

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

Set UI Container to add panel to.

◆ setUIContainerAddSettings()

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

Set settings use to add prompt widget to UI Container.

◆ setVisibleIfEmpty()

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

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

Version
1.19

Member Data Documentation

◆ pBindingIconHeight

int Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pBindingIconHeight

◆ pECBehavior

ECBehaviorPlayerLookAtInteractPrompt Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pECBehavior

◆ pEnabled

bool Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pEnabled

◆ pListeners

Array Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pListeners

◆ pLookAt

ECBehaviorLookAt.Instance Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pLookAt

◆ pPlayerControllable

ECBehaviorPlayerControllable.Instance Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pPlayerControllable

◆ pPromptController

PromptController Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pPromptController

◆ pTransparency

float Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pTransparency

◆ pUIContainer

Container Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pUIContainer

◆ pVisibleIfEmpty

bool Dragengine.Scenery.ECBehaviorPlayerLookAtInteractPrompt.Instance.pVisibleIfEmpty

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