Dragengine.Scenery.ECBehaviorInteractPrompt.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorInteractPrompt.Instance:

Public Member Functions
void	forEachBone (Block ablock)
	Visit bones bones this prompt is limited to using block.
Array	getAlternativeCommands ()
	Alternative commands as Array of String.
String	getBoneAt (int index)
	Bone at index this prompt is limited to.
int	getBoneCount ()
	Count of bones this prompt is limited to.
String	getCommand ()
	Command.
UnicodeString	getDescription ()
	Description.
ECBehaviorInteractPrompt	getECBehavior ()
	Behavior.
bool	getEnabled ()
	Prompt is enabled.
Image	getImage ()
	Image.
float	getMaximumDistance ()
	Maximum distance to show interact prompt for when looking at it.
String	getSettings ()
	Optional settings to modify display in custom prompt widgets.
String	getStyle ()
	Style.
UnicodeString	getVerb ()
	Verb.
Video	getVideo ()
	Video.
bool	hasBone (String bone)
	Bone is included in list of bones this prompt is limited to.
void	init (StubElement stub)
	Initialize element from stub.
Instance	new (ECBehaviorInteractPrompt ecbehavior, BehaviorElement element)
	Create behavior instance.
void	setCommand (String command)
	Set command.
void	setDescription (UnicodeString description)
	Set description.
void	setEnabled (bool enabled)
	Set if prompt is enabled.
void	setImage (Image image)
	Set image.
void	setMaximumDistance (float distance)
	Set maximum distance to show interact prompt for when looking at it.
void	setSettings (String settings)
	Set optional settings to modify display in custom prompt widgets.
void	setStyle (String style)
	Set style.
void	setVerb (UnicodeString verb)
	Set verb.
void	setVideo (Video video)
	Set video.
Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	addToGameWorld ()
	Add element to game world.
void	attachToParent (Element parent)
	Attach element to object set by the mapper in the IGDE World Editor.
void	dispose ()
	Dispose of behavior instance.
void	enterFrame ()
	Frame update started.
void	geometryChanged ()
	Position or orientation changed.
BehaviorElement	getElement ()
	Behavior element to apply behavior to.
int	getInstanceIndex ()
	Behavior instance index.
DefaultECBehaviorInstance	new (BehaviorElement element)
	Create default composeable instance.
void	postThink (float elapsed)
	Post thinking after physics processing is finished.
void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read behavior instance from file.
void	removeFromGameWorld ()
	Remove element from game world.
bool	requiresEnterFrame ()
	Behavior instance requires enterFrame() to be called.
bool	requiresThink ()
	Behavior instance requires think() to be called.
void	stateChanged ()
	State changed (visble, touchable).
void	think (float elapsed)
	Think about what to do for the next frame update.
void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write behavior instance to file.

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
Public Attributes inherited from Dragengine.Scenery.DefaultECBehaviorInstance
BehaviorElement	pElement
int	pInstanceIndex
bool	pRequiresEnterFrame
bool	pRequiresThink

Protected Member Functions
void	setBones (Array bones)
	Set list of bones this prompt is limited to as Array of String.
Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	setRequiresEnterFrame (bool required)
	Set if behavior instance requires enterFrame() to be called.
void	setRequiresThink (bool required)
	Set if behavior instance requires think() to be called.

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:

• ECBehaviorInteractPrompt.ds