Dev » Lua API » dialoguestep

dialoguestep

Dialogue 15 Properties 36 Methods

dialoguestep

The dialoguestep class represents a single step or decision node in a dialogue sequence. Supports interactive player choices (options), branch conditions, media, and transitions.

Overview Properties (15) Methods (36) Detailed Reference ↓

Overview

Properties (15)

Property	Type	Summary
`entities`	`table`	Table of associated entities.
`entity`	`entity`	The speaking entity associated with this step.
`extraPosition`	`vector3`	3D camera pan position.
`falseNext`	`number`	Target step index when condition evaluates false.
`hasOptions`	`boolean`	Checks if step has choice options.
`media`	`string`	Sound or music resource path.
`next`	`number`	Target step index for primary connection.
`optionCount`	`number`	Number of choice options on step.
`position`	`vector2`	Graph editor 2D position.
`script`	`string`	Lua script executed on step activation.
`text`	`string`	The text line or script content.
`title`	`string`	Title or label of the step.
`trueNext`	`number`	Target step index when condition evaluates true.
`type`	`number`	The step type ID (see dialoguesteptype).
`typeName`	`string`	The step type name string.

Methods (36)

Method Signature	Returns	Summary
`dialoguestep:addBranch(valueOrWeight, [target], [action])`	`dialoguestep`	Adds a branch for switch or random step.
`dialoguestep:addEntity(entityVal)`	`dialoguestep`	Adds an entity to the step.
`dialoguestep:addOption(arg1, [arg2], [arg3], [arg4])`	`dialoguestep`	Adds an interactive choice option button.
`dialoguestep:clearOptions()`	`dialoguestep`	Clears all choice options from this step.
`dialoguestep:clone()`	`dialoguestep`	Creates a deep copy of this dialogue step.
`dialoguestep:connect(nextVal)`	`dialoguestep`	Connects primary exit connection to next step.
`dialoguestep:connectFalse(nextVal)`	`dialoguestep`	Connects FALSE condition exit connection.
`dialoguestep:connectTrue(nextVal)`	`dialoguestep`	Connects TRUE condition exit connection.
`dialoguestep.createCamera(target)`	`dialoguestep`	Static factory for camera pan step.
`dialoguestep.createCondition(script, [trueTarget], [falseTarget])`	`dialoguestep`	Static factory for condition step.
`dialoguestep.createDelay(seconds)`	`dialoguestep`	Static factory for timed delay step.
`dialoguestep.createEntity(entity, text)`	`dialoguestep`	Static factory for NPC dialogue step.
`dialoguestep.createMusic(media)`	`dialoguestep`	Static factory for music step.
`dialoguestep.createNarrative(text)`	`dialoguestep`	Static factory for narrative text step.
`dialoguestep.createPlayer(text)`	`dialoguestep`	Static factory for player dialogue step.
`dialoguestep.createRadio(entity, text)`	`dialoguestep`	Static factory for radio dialogue step.
`dialoguestep.createRandom()`	`dialoguestep`	Static factory for random branch step.
`dialoguestep.createSwitch(script)`	`dialoguestep`	Static factory for switch step.
`dialoguestep:getOption(index)`	`table`	Gets data for a choice option.
`dialoguestep:getOptions()`	`table`	Gets all choice options.
`dialoguestep.new([type], [text], [entity])`	`dialoguestep`	Constructs a new dialogue step.
`dialoguestep:removeOption(index)`	`boolean`	Removes a choice option by index.
`dialoguestep:setEntities(entitiesVal)`	`dialoguestep`	Sets associated entities.
`dialoguestep:setEntity(entityVal)`	`dialoguestep`	Sets speaking entity.
`dialoguestep:setExtraPosition(arg1, [y], [z])`	`dialoguestep`	Sets 3D extra camera position.
`dialoguestep:setMedia(media)`	`dialoguestep`	Sets media resource path.
`dialoguestep:setOptionAction(index, action)`	`boolean`	Sets the Lua callback function executed when option is clicked.
`dialoguestep:setOptionCondition(index, conditionScript)`	`boolean`	Sets the display condition script for an option.
`dialoguestep:setOptionNext(index, target)`	`boolean`	Updates the destination step of an option.
`dialoguestep:setOptionText(index, text)`	`boolean`	Updates the label text of an option.
`dialoguestep:setPosition(arg1, [y])`	`dialoguestep`	Sets 2D graph editor position.
`dialoguestep:setScript(script)`	`dialoguestep`	Sets activation script.
`dialoguestep:setText(text)`	`dialoguestep`	Sets dialogue text line.
`dialoguestep:setTitle(title)`	`dialoguestep`	Sets step title.
`dialoguestep:setType(typeVal)`	`dialoguestep`	Sets step type.
`dialoguestep:show()`	`void`	Displays this step immediately in the dialogue UI.

Detailed Reference

# entities PROPERTY

↑ Overview

dialoguestep.entities

Table of associated entities.

Parameters

None

Returns

table

Array of associated entities.

Description

Gets or sets array of associated entities.

# entity PROPERTY

↑ Overview

dialoguestep.entity

The speaking entity associated with this step.

Parameters

None

Returns

entity

Speaking entity or nil.

Description

Gets or sets the speaking entity.

# extraPosition PROPERTY

↑ Overview

dialoguestep.extraPosition

3D camera pan position.

Parameters

None

Returns

vector3

3D camera pan position.

Description

Target coordinates for camera panning.

# falseNext PROPERTY

↑ Overview

dialoguestep.falseNext

Target step index when condition evaluates false.

Parameters

None

Returns

number

False branch step index.

Description

Target step when condition fails.

# hasOptions PROPERTY

↑ Overview

dialoguestep.hasOptions

Checks if step has choice options.

Parameters

None

Returns

boolean

True if options exist.

Description

Returns true if interactive choices are configured.

# media PROPERTY

↑ Overview

dialoguestep.media

Sound or music resource path.

Parameters

None

Returns

string

Media resource path.

Description

Gets or sets audio media path.

# next PROPERTY

↑ Overview

dialoguestep.next

Target step index for primary connection.

Parameters

None

Returns

number

Next step index.

Description

Next step index.

# optionCount PROPERTY

↑ Overview

dialoguestep.optionCount

Number of choice options on step.

Parameters

None

Returns

number

Option count.

Description

Returns count of choices.

# position PROPERTY

↑ Overview

dialoguestep.position

Graph editor 2D position.

Parameters

None

Returns

vector2

Graph position.

Description

Position in node graph editor.

# script PROPERTY

↑ Overview

dialoguestep.script

Lua script executed on step activation.

Parameters

None

Returns

string

Script string.

Description

Gets or sets trigger script.

# text PROPERTY

↑ Overview

dialoguestep.text

The text line or script content.

Parameters

None

Returns

string

Dialogue text line.

Description

Gets or sets the dialogue speech text or script string.

# title PROPERTY

↑ Overview

dialoguestep.title

Title or label of the step.

Parameters

None

Returns

string

Step title.

Description

Gets or sets step title.

# trueNext PROPERTY

↑ Overview

dialoguestep.trueNext

Target step index when condition evaluates true.

Parameters

None

Returns

number

True branch step index.

Description

Target step when condition passes.

# type PROPERTY

↑ Overview

dialoguestep.type

The step type ID (see dialoguesteptype).

Parameters

None

Returns

number

Dialogue step type integer ID.

Description

Gets or sets the step type.

# typeName PROPERTY

↑ Overview

dialoguestep.typeName

The step type name string.

Parameters

None

Returns

string

Step type name string.

Description

Returns step type name (e.g. "NarrativeText", "EntityDialogue", "Condition").

# addBranch METHOD

↑ Overview

dialoguestep:addBranch(valueOrWeight, [target], [action])

Adds a branch for switch or random step.

Parameters

Parameter	Type	Default	Description
`valueOrWeight`	string\|number		Value key or random weight.
`target`	dialoguestep\|number	optional	Destination step.
`action`	function	optional	Callback.

Returns

dialoguestep

Self.

Description

Appends a case or weight branch.

# addEntity METHOD

↑ Overview

dialoguestep:addEntity(entityVal)

Adds an entity to the step.

Parameters

Parameter	Type	Default	Description
`entityVal`	entity\|number		Entity to add.

Returns

dialoguestep

Self.

Description

Appends entity to step entities.

# addOption METHOD

↑ Overview

dialoguestep:addOption(arg1, [arg2], [arg3], [arg4])

Adds an interactive choice option button.

Parameters

Parameter	Type	Default	Description
`arg1`	string\|table		Option text or table with {text, next, action, condition}.
`arg2`	dialoguestep\|number\|function\|string	optional	Next step, action callback, or condition script.
`arg3`	dialoguestep\|number\|function\|string	optional	Additional option parameter.
`arg4`	dialoguestep\|number\|function\|string	optional	Additional option parameter.

Returns

dialoguestep

Self.

Description

Adds a player response button to this dialogue step.

step:addOption("Sure, I can help!", nextStep, function()
    print("Player agreed to quest!")
end)

# clearOptions METHOD

↑ Overview

dialoguestep:clearOptions()

Clears all choice options from this step.

Parameters

None

Returns

dialoguestep

Self.

Description

Removes all options.

# clone METHOD

↑ Overview

dialoguestep:clone()

Creates a deep copy of this dialogue step.

Parameters

None

Returns

dialoguestep

Cloned step.

Description

Duplicates the step.

# connect METHOD

↑ Overview

dialoguestep:connect(nextVal)

Connects primary exit connection to next step.

Parameters

Parameter	Type	Default	Description
`nextVal`	dialoguestep\|number\|nil		Destination step.

Returns

dialoguestep

Self.

Description

Wires transition to nextVal.

# connectFalse METHOD

↑ Overview

dialoguestep:connectFalse(nextVal)

Connects FALSE condition exit connection.

Parameters

Parameter	Type	Default	Description
`nextVal`	dialoguestep\|number\|nil		Destination step if false.

Returns

dialoguestep

Self.

Description

Wires false branch to nextVal.

# connectTrue METHOD

↑ Overview

dialoguestep:connectTrue(nextVal)

Connects TRUE condition exit connection.

Parameters

Parameter	Type	Default	Description
`nextVal`	dialoguestep\|number\|nil		Destination step if true.

Returns

dialoguestep

Self.

Description

Wires true branch to nextVal.

# createCamera METHOD

↑ Overview

dialoguestep.createCamera(target)

Static factory for camera pan step.

Parameters

Parameter	Type	Default	Description
`target`	entity\|vector3		Camera target.

Returns

dialoguestep

Created step.

Description

Creates a camera panning step.

# createCondition METHOD

↑ Overview

dialoguestep.createCondition(script, [trueTarget], [falseTarget])

Static factory for condition step.

Parameters

Parameter	Type	Default	Description
`script`	string		Condition script.
`trueTarget`	dialoguestep\|number	optional	True branch.
`falseTarget`	dialoguestep\|number	optional	False branch.

Returns

dialoguestep

Created step.

Description

Creates a conditional branch step.

# createDelay METHOD

↑ Overview

dialoguestep.createDelay(seconds)

Static factory for timed delay step.

Parameters

Parameter	Type	Default	Description
`seconds`	number		Seconds to wait.

Returns

dialoguestep

Created step.

Description

Creates a pause step.

# createEntity METHOD

↑ Overview

dialoguestep.createEntity(entity, text)

Static factory for NPC dialogue step.

Parameters

Parameter	Type	Default	Description
`entity`	entity\|number		Speaking NPC.
`text`	string		NPC speech line.

Returns

dialoguestep

Created step.

Description

Creates an NPC speech step.

# createMusic METHOD

↑ Overview

dialoguestep.createMusic(media)

Static factory for music step.

Parameters

Parameter	Type	Default	Description
`media`	string		Music path.

Returns

dialoguestep

Created step.

Description

Creates a background music step.

# createNarrative METHOD

↑ Overview

dialoguestep.createNarrative(text)

Static factory for narrative text step.

Parameters

Parameter	Type	Default	Description
`text`	string		Narrative caption.

Returns

dialoguestep

Created step.

Description

Creates a narrative caption step.

# createPlayer METHOD

↑ Overview

dialoguestep.createPlayer(text)

Static factory for player dialogue step.

Parameters

Parameter	Type	Default	Description
`text`	string		Player line.

Returns

dialoguestep

Created step.

Description

Creates a player speech step.

# createRadio METHOD

↑ Overview

dialoguestep.createRadio(entity, text)

Static factory for radio dialogue step.

Parameters

Parameter	Type	Default	Description
`entity`	entity\|number		Radio transmission source.
`text`	string		Message.

Returns

dialoguestep

Created step.

Description

Creates a radio transmission step.

# createRandom METHOD

↑ Overview

dialoguestep.createRandom()

Static factory for random branch step.

Parameters

None

Returns

dialoguestep

Created step.

Description

Creates a random choice step.

# createSwitch METHOD

↑ Overview

dialoguestep.createSwitch(script)

Static factory for switch step.

Parameters

Parameter	Type	Default	Description
`script`	string		Switch script.

Returns

dialoguestep

Created step.

Description

Creates a multi-case switch step.

# getOption METHOD

↑ Overview

dialoguestep:getOption(index)

Gets data for a choice option.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.

Returns

table

Option details table {text, connection, action, condition, target}.

Description

Returns table of option configuration.

# getOptions METHOD

↑ Overview

dialoguestep:getOptions()

Gets all choice options.

Parameters

None

Returns

table

1-based array of option tables.

Description

Returns an array of option tables.

# new METHOD

↑ Overview

dialoguestep.new([type], [text], [entity])

Constructs a new dialogue step.

Parameters

Parameter	Type	Default	Description
`type`	number\|string\|table	optional	Step type or config table.
`text`	string	`""`	Text line.
`entity`	entity\|number	optional	Speaking entity.

Returns

dialoguestep

Created step.

Description

Creates a dialogue step with specified attributes.

# removeOption METHOD

↑ Overview

dialoguestep:removeOption(index)

Removes a choice option by index.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.

Returns

boolean

True if removed.

Description

Deletes option at index.

# setEntities METHOD

↑ Overview

dialoguestep:setEntities(entitiesVal)

Sets associated entities.

Parameters

Parameter	Type	Default	Description
`entitiesVal`	table\|entity\|number		Associated entities.

Returns

dialoguestep

Self.

Description

Updates associated entities.

# setEntity METHOD

↑ Overview

dialoguestep:setEntity(entityVal)

Sets speaking entity.

Parameters

Parameter	Type	Default	Description
`entityVal`	entity\|number\|string\|nil		Speaking entity.

Returns

dialoguestep

Self.

Description

Sets speaker entity.

# setExtraPosition METHOD

↑ Overview

dialoguestep:setExtraPosition(arg1, [y], [z])

Sets 3D extra camera position.

Parameters

Parameter	Type	Default	Description
`arg1`	vector3\|number		Position vector or X.
`y`	number	`0`	Y coordinate.
`z`	number	`0`	Z coordinate.

Returns

dialoguestep

Self.

Description

Updates 3D target coordinates.

# setMedia METHOD

↑ Overview

dialoguestep:setMedia(media)

Sets media resource path.

Parameters

Parameter	Type	Default	Description
`media`	string		Audio path.

Returns

dialoguestep

Self.

Description

Updates media path.

# setOptionAction METHOD

↑ Overview

dialoguestep:setOptionAction(index, action)

Sets the Lua callback function executed when option is clicked.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.
`action`	function\|nil		Lua callback function.

Returns

boolean

True if updated.

Description

Assigns action callback.

# setOptionCondition METHOD

↑ Overview

dialoguestep:setOptionCondition(index, conditionScript)

Sets the display condition script for an option.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.
`conditionScript`	string		Script returning boolean to show option.

Returns

boolean

True if updated.

Description

Controls whether option button appears based on condition.

# setOptionNext METHOD

↑ Overview

dialoguestep:setOptionNext(index, target)

Updates the destination step of an option.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.
`target`	dialoguestep\|number\|nil		Destination step.

Returns

boolean

True if updated.

Description

Wires option to target.

# setOptionText METHOD

↑ Overview

dialoguestep:setOptionText(index, text)

Updates the label text of an option.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based option index.
`text`	string		New option label.

Returns

boolean

True if updated.

Description

Modifies option button text.

# setPosition METHOD

↑ Overview

dialoguestep:setPosition(arg1, [y])

Sets 2D graph editor position.

Parameters

Parameter	Type	Default	Description
`arg1`	vector2\|number		Position vector or X.
`y`	number	`0`	Y coordinate.

Returns

dialoguestep

Self.

Description

Updates position in graph.

# setScript METHOD

↑ Overview

dialoguestep:setScript(script)

Sets activation script.

Parameters

Parameter	Type	Default	Description
`script`	string		Lua script.

Returns

dialoguestep

Self.

Description

Updates script.

# setText METHOD

↑ Overview

dialoguestep:setText(text)

Sets dialogue text line.

Parameters

Parameter	Type	Default	Description
`text`	string		Text content.

Returns

dialoguestep

Self.

Description

Updates line text.

# setTitle METHOD

↑ Overview

dialoguestep:setTitle(title)

Sets step title.

Parameters

Parameter	Type	Default	Description
`title`	string		Title string.

Returns

dialoguestep

Self.

Description

Updates step title.

# setType METHOD

↑ Overview

dialoguestep:setType(typeVal)

Sets step type.

Parameters

Parameter	Type	Default	Description
`typeVal`	number\|string		Type ID or name.

Returns

dialoguestep

Self.

Description

Updates step type.

# show METHOD

↑ Overview

dialoguestep:show()

Displays this step immediately in the dialogue UI.

Parameters

None

Returns

None (void)

Description

Opens dialogue screen and renders this step.

Dev

Lua API

Assets

dialoguestep

dialoguestep

Overview

Properties (15)

Methods (36)

Detailed Reference