Dev » Lua API » dialogue

dialogue

Dialogue 6 Properties 25 Methods

dialogue

The dialogue class represents complete interactive dialogue sequences, NPC cutscenes, and narrative event graphs. Supports adding narrative captions, player choices, conditions, camera panning, and starting the dialogue UI screen.

Overview Properties (6) Methods (25) Detailed Reference ↓

Overview

Properties (6)

Property	Type	Summary
`count`	`number`	Total count of steps in the dialogue.
`isOpen`	`boolean`	Alias for isShowing.
`isShowing`	`boolean`	Checks if the dialogue is currently being shown.
`startStep`	`dialoguestep`	The starting step of the dialogue.
`stepCount`	`number`	Alias for count.
`steps`	`table`	Table of all dialogue steps.

Methods (25)

Method Signature	Returns	Summary
`dialogue:addCamera(target)`	`dialoguestep`	Adds a camera panning step.
`dialogue:addCondition(script, [trueTarget], [falseTarget])`	`dialoguestep`	Adds a conditional branch step.
`dialogue:addDelay(seconds)`	`dialoguestep`	Adds a timed pause/delay step.
`dialogue:addEntity(entity, text)`	`dialoguestep`	Adds an NPC dialogue line step.
`dialogue:addMusic(media)`	`dialoguestep`	Adds a background music change step.
`dialogue:addNarrative(text)`	`dialoguestep`	Adds a narrative text step.
`dialogue:addPlayer(text)`	`dialoguestep`	Adds a player dialogue line step.
`dialogue:addRadio(entity, text)`	`dialoguestep`	Adds a radio transmission dialogue step.
`dialogue:addRandom()`	`dialoguestep`	Adds a random branch step.
`dialogue:addStep(stepVal, [textVal], [entityVal])`	`dialoguestep`	Adds a step to the dialogue sequence.
`dialogue:addSwitch(script)`	`dialoguestep`	Adds a multi-branch switch step.
`dialogue:chain(...)`	`dialogue`	Chains multiple steps sequentially in order.
`dialogue:clear()`	`void`	Clears all steps from the dialogue.
`dialogue.close()`	`void`	Closes any currently active dialogue screen.
`dialogue:connect(fromVal, toVal)`	`dialogue`	Connects the output of one step to another.
`dialogue.getCurrent()`	`dialogue`	Returns the currently displayed dialogue.
`dialogue:getStep(index)`	`dialoguestep`	Gets a step by 1-based index.
`dialogue:getStepByTitle(title)`	`dialoguestep`	Finds a step by its title.
`dialogue:indexOf(step)`	`number`	Finds the index of a step.
`dialogue:insertStep(index, stepVal, [textVal], [entityVal])`	`dialoguestep`	Inserts a step at the specified index.
`dialogue.isDisplayed()`	`boolean`	Static check if a dialogue screen is currently open.
`dialogue.new([stepsTable])`	`dialogue`	Constructs a new dialogue container.
`dialogue:removeStep(stepOrIndex)`	`boolean`	Removes a step from the dialogue.
`dialogue:resolveConnections()`	`void`	Resolves object references into internal step index connections.
`dialogue:show([arg1], [arg2])`	`dialogue`	Displays and begins dialogue playback on screen.

Detailed Reference

# count PROPERTY

↑ Overview

dialogue.count

Total count of steps in the dialogue.

Parameters

None

Returns

number

Total number of steps.

Description

Returns the number of steps.

# isOpen PROPERTY

↑ Overview

dialogue.isOpen

Alias for isShowing.

Parameters

None

Returns

boolean

True if open.

Description

Checks if dialogue is open.

# isShowing PROPERTY

↑ Overview

dialogue.isShowing

Checks if the dialogue is currently being shown.

Parameters

None

Returns

boolean

True if dialogue screen is open.

Description

Returns true if the dialogue UI is open and displaying.

# startStep PROPERTY

↑ Overview

dialogue.startStep

The starting step of the dialogue.

Parameters

None

Returns

dialoguestep

The initial step.

Description

Gets or sets the first step to display when dialogue opens.

# stepCount PROPERTY

↑ Overview

dialogue.stepCount

Alias for count.

Parameters

None

Returns

number

Total number of steps.

Description

Returns total step count.

# steps PROPERTY

↑ Overview

dialogue.steps

Table of all dialogue steps.

Parameters

None

Returns

table

1-based array of dialoguestep objects.

Description

Returns an array of all dialogue step objects.

# addCamera METHOD

↑ Overview

dialogue:addCamera(target)

Adds a camera panning step.

Parameters

Parameter	Type	Default	Description
`target`	entity\|vector3		Target entity or 3D coordinate.

Returns

dialoguestep

Created step.

Description

Appends a step that pans the camera toward target.

# addCondition METHOD

↑ Overview

dialogue:addCondition(script, [trueTarget], [falseTarget])

Adds a conditional branch step.

Parameters

Parameter	Type	Default	Description
`script`	string		Condition script returning boolean.
`trueTarget`	dialoguestep\|number	optional	Step if true.
`falseTarget`	dialoguestep\|number	optional	Step if false.

Returns

dialoguestep

Created step.

Description

Appends an if/else conditional branch step.

# addDelay METHOD

↑ Overview

dialogue:addDelay(seconds)

Adds a timed pause/delay step.

Parameters

Parameter	Type	Default	Description
`seconds`	number		Pause duration in seconds.

Returns

dialoguestep

Created step.

Description

Appends a timed delay step.

# addEntity METHOD

↑ Overview

dialogue:addEntity(entity, text)

Adds an NPC dialogue line step.

Parameters

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

Returns

dialoguestep

Created step.

Description

Appends a speech step spoken by an NPC entity.

# addMusic METHOD

↑ Overview

dialogue:addMusic(media)

Adds a background music change step.

Parameters

Parameter	Type	Default	Description
`media`	string		Audio stream resource path.

Returns

dialoguestep

Created step.

Description

Appends a step that triggers music playback.

# addNarrative METHOD

↑ Overview

dialogue:addNarrative(text)

Adds a narrative text step.

Parameters

Parameter	Type	Default	Description
`text`	string		Narrative caption text.

Returns

dialoguestep

Created step.

Description

Appends a narrative text caption step.

# addPlayer METHOD

↑ Overview

dialogue:addPlayer(text)

Adds a player dialogue line step.

Parameters

Parameter	Type	Default	Description
`text`	string		Player dialogue text.

Returns

dialoguestep

Created step.

Description

Appends a speech step spoken by the player.

# addRadio METHOD

↑ Overview

dialogue:addRadio(entity, text)

Adds a radio transmission dialogue step.

Parameters

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

Returns

dialoguestep

Created step.

Description

Appends a radio/intercom message step.

# addRandom METHOD

↑ Overview

dialogue:addRandom()

Adds a random branch step.

Parameters

None

Returns

dialoguestep

Created step.

Description

Appends a step that randomly branches among its options.

# addStep METHOD

↑ Overview

dialogue:addStep(stepVal, [textVal], [entityVal])

Adds a step to the dialogue sequence.

Parameters

Parameter	Type	Default	Description
`stepVal`	dialoguestep\|table\|number		Step object or config table.
`textVal`	string	`""`	Text line.
`entityVal`	entity\|number	optional	Speaking entity.

Returns

dialoguestep

Added step.

Description

Appends a step to the dialogue.

# addSwitch METHOD

↑ Overview

dialogue:addSwitch(script)

Adds a multi-branch switch step.

Parameters

Parameter	Type	Default	Description
`script`	string		Lua expression returning branch key.

Returns

dialoguestep

Created step.

Description

Appends a switch branch step evaluated by script.

# chain METHOD

↑ Overview

dialogue:chain(...)

Chains multiple steps sequentially in order.

Parameters

Parameter	Type	Default	Description
`...`	dialoguestep\|table		Sequential steps or table of steps.

Returns

dialogue

Self for fluent chaining.

Description

Connects all passed steps one after the other in linear sequence.

dlg:chain(step1, step2, step3)

# clear METHOD

↑ Overview

dialogue:clear()

Clears all steps from the dialogue.

Parameters

None

Returns

None (void)

Description

Empties the dialogue sequence.

# close METHOD

↑ Overview

dialogue.close()

Closes any currently active dialogue screen.

Parameters

None

Returns

None (void)

Description

Terminates active dialogue playback and closes the UI.

# connect METHOD

↑ Overview

dialogue:connect(fromVal, toVal)

Connects the output of one step to another.

Parameters

Parameter	Type	Default	Description
`fromVal`	dialoguestep\|number		Source step.
`toVal`	dialoguestep\|number		Destination step.

Returns

dialogue

Self for fluent chaining.

Description

Wires step fromVal to transition to toVal.

dlg:connect(step1, step2)

# getCurrent METHOD

↑ Overview

dialogue.getCurrent()

Returns the currently displayed dialogue.

Parameters

None

Returns

dialogue

Active dialogue or nil.

Description

Gets active dialogue instance.

# getStep METHOD

↑ Overview

dialogue:getStep(index)

Gets a step by 1-based index.

Parameters

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

Returns

dialoguestep

Step or nil.

Description

Retrieves step at index.

# getStepByTitle METHOD

↑ Overview

dialogue:getStepByTitle(title)

Finds a step by its title.

Parameters

Parameter	Type	Default	Description
`title`	string		Step title label.

Returns

dialoguestep

Matching step or nil.

Description

Searches steps for a title match.

# indexOf METHOD

↑ Overview

dialogue:indexOf(step)

Finds the index of a step.

Parameters

Parameter	Type	Default	Description
`step`	dialoguestep		Target step.

Returns

number

1-based index, or 0 if not found.

Description

Returns 1-based index of step.

# insertStep METHOD

↑ Overview

dialogue:insertStep(index, stepVal, [textVal], [entityVal])

Inserts a step at the specified index.

Parameters

Parameter	Type	Default	Description
`index`	number		1-based insertion index.
`stepVal`	dialoguestep\|table\|number		Step object or type.
`textVal`	string	`""`	Text line.
`entityVal`	entity\|number	optional	Speaking entity.

Returns

dialoguestep

Inserted step.

Description

Inserts a step into the dialogue sequence at index.

# isDisplayed METHOD

↑ Overview

dialogue.isDisplayed()

Static check if a dialogue screen is currently open.

Parameters

None

Returns

boolean

True if dialogue screen is active.

Description

Returns true if any dialogue is being displayed.

# new METHOD

↑ Overview

dialogue.new([stepsTable])

Constructs a new dialogue container.

Parameters

Parameter	Type	Default	Description
`stepsTable`	table	`{}`	Array of initial steps.

Returns

dialogue

New dialogue instance.

Description

Creates an empty dialogue container.

local dlg = dialogue.new()

# removeStep METHOD

↑ Overview

dialogue:removeStep(stepOrIndex)

Removes a step from the dialogue.

Parameters

Parameter	Type	Default	Description
`stepOrIndex`	dialoguestep\|number		Step object or 1-based index.

Returns

boolean

True if removed.

Description

Deletes the specified step from dialogue.

# resolveConnections METHOD

↑ Overview

dialogue:resolveConnections()

Resolves object references into internal step index connections.

Parameters

None

Returns

None (void)

Description

Translates step target object pointers into internal integer step indices.

# show METHOD

↑ Overview

dialogue:show([arg1], [arg2])

Displays and begins dialogue playback on screen.

Parameters

Parameter	Type	Default	Description
`arg1`	dialoguestep\|number\|function	optional	Starting step or onEnd callback.
`arg2`	dialoguestep\|number\|function	optional	Starting step or onEnd callback.

Returns

dialogue

Self.

Description

Opens the dialogue screen and begins playback.

dlg:show(function(d, s)
    print("Dialogue concluded!")
end)

Dev

Lua API

Assets

dialogue

dialogue

Overview

Properties (6)

Methods (25)

Detailed Reference