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

Behavior instance. More...

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

Public Member Functions

void forEachBone (Block ablock)
 Visit bones bones this prompt is limited to using block. More...
 
Array getAlternativeCommands ()
 Alternative commands as Array of String. More...
 
String getBoneAt (int index)
 Bone at index this prompt is limited to. More...
 
int getBoneCount ()
 Count of bones this prompt is limited to. More...
 
String getCommand ()
 Command. More...
 
UnicodeString getDescription ()
 Description. More...
 
ECBehaviorInteractPrompt getECBehavior ()
 Behavior. More...
 
bool getEnabled ()
 Prompt is enabled. More...
 
Image getImage ()
 Image. More...
 
float getMaximumDistance ()
 Maximum distance to show interact prompt for when looking at it. More...
 
String getSettings ()
 Optional settings to modify display in custom prompt widgets. More...
 
String getStyle ()
 Style. More...
 
UnicodeString getVerb ()
 Verb. More...
 
Video getVideo ()
 Video. More...
 
bool hasBone (String bone)
 Bone is included in list of bones this prompt is limited to. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (ECBehaviorInteractPrompt ecbehavior, BehaviorElement element)
 Create behavior instance. More...
 
void setCommand (String command)
 Set command. More...
 
void setDescription (UnicodeString description)
 Set description. More...
 
void setEnabled (bool enabled)
 Set if prompt is enabled. More...
 
void setImage (Image image)
 Set image. More...
 
void setMaximumDistance (float distance)
 Set maximum distance to show interact prompt for when looking at it. More...
 
void setSettings (String settings)
 Set optional settings to modify display in custom prompt widgets. More...
 
void setStyle (String style)
 Set style. More...
 
void setVerb (UnicodeString verb)
 Set verb. More...
 
void setVideo (Video video)
 Set video. 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 dispose ()
 Dispose of behavior instance. 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...
 

Public Attributes

Array pAlternativeCommands
 
Array pBones
 
String pCommand
 
UnicodeString pDescription
 
String pDescriptionTranslate
 
ECBehaviorInteractPrompt pECBehavior
 
bool pEnabled
 
Image pImage
 
float pMaximumDistance
 
String pSettings
 
String pStyle
 
UnicodeString pVerb
 
String pVerbTranslate
 
Video pVideo
 

Protected Member Functions

void setBones (Array bones)
 Set list of bones this prompt is limited to as Array of String. 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

◆ forEachBone()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.forEachBone ( Block  ablock)

Visit bones bones this prompt is limited to using block.

Block receives as argument "String bone".

◆ getAlternativeCommands()

Array Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getAlternativeCommands ( )

Alternative commands as Array of String.

Version
1.20

◆ getBoneAt()

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getBoneAt ( int  index)

Bone at index this prompt is limited to.

◆ getBoneCount()

int Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getBoneCount ( )

Count of bones this prompt is limited to.

◆ getCommand()

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getCommand ( )

Command.

◆ getDescription()

UnicodeString Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getDescription ( )

Description.

◆ getECBehavior()

ECBehaviorInteractPrompt Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getECBehavior ( )

Behavior.

◆ getEnabled()

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

Prompt is enabled.

◆ getImage()

Image Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getImage ( )

Image.

◆ getMaximumDistance()

float Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getMaximumDistance ( )

Maximum distance to show interact prompt for when looking at it.

Version
1.18

◆ getSettings()

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getSettings ( )

Optional settings to modify display in custom prompt widgets.

Version
1.19

Can be null.

◆ getStyle()

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getStyle ( )

Style.

◆ getVerb()

UnicodeString Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getVerb ( )

Verb.

◆ getVideo()

Video Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.getVideo ( )

Video.

◆ hasBone()

bool Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.hasBone ( String  bone)

Bone is included in list of bones this prompt is limited to.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

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

Create behavior instance.

◆ setBones()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setBones ( Array  bones)
protected

Set list of bones this prompt is limited to as Array of String.

◆ setCommand()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setCommand ( String  command)

Set command.

◆ setDescription()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setDescription ( UnicodeString  description)

Set description.

◆ setEnabled()

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

Set if prompt is enabled.

◆ setImage()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setImage ( Image  image)

Set image.

◆ setMaximumDistance()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setMaximumDistance ( float  distance)

Set maximum distance to show interact prompt for when looking at it.

Version
1.18

◆ setSettings()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setSettings ( String  settings)

Set optional settings to modify display in custom prompt widgets.

Version
1.19

Can be null.

◆ setStyle()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setStyle ( String  style)

Set style.

◆ setVerb()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setVerb ( UnicodeString  verb)

Set verb.

◆ setVideo()

void Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.setVideo ( Video  video)

Set video.

Member Data Documentation

◆ pAlternativeCommands

Array Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pAlternativeCommands

◆ pBones

Array Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pBones

◆ pCommand

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pCommand

◆ pDescription

UnicodeString Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pDescription

◆ pDescriptionTranslate

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pDescriptionTranslate

◆ pECBehavior

ECBehaviorInteractPrompt Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pECBehavior

◆ pEnabled

bool Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pEnabled

◆ pImage

Image Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pImage

◆ pMaximumDistance

float Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pMaximumDistance

◆ pSettings

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pSettings

◆ pStyle

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pStyle

◆ pVerb

UnicodeString Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pVerb

◆ pVerbTranslate

String Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pVerbTranslate

◆ pVideo

Video Dragengine.Scenery.ECBehaviorInteractPrompt.Instance.pVideo

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