Game logic - Dialogue – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[[Ylands " to "[[Ylands:")
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Description=
=Description=
Shows player a window of predefined options, which can be selected from. Each option then can execute its own sequence of actions.
When initiated using [[Ylands:Tile - Show dialogue|'''Show Dialogue''']] instruction, it will display a window of predefined options as defined in properties. After selecting a option [[Ylands:Tile - Dialogue On Answer|'''On Answer''']] event will be called inside the Dialogue logic. It's possible to show/hide answer options using [[Ylands:Tile - Answer enabled|'''Answer Enabled''']] instruction, or modify their text.


*Dialogue between player and world entity (i.e NPC)
*Dialogue between player and world entity (i.e NPC)
*Initiated via Show dialog instruction
*Initiated via '''Show Dialog''' instruction
*Player selects from pre-defined answers
*Player selects from pre-defined answers
*Each answer can call different script instructions
*Each answer can call different script instructions
*Selected answer is obtained via Answer id, when On answered event is called (see example)
*Selected answer is obtained via '''Answer Id''' in '''On Answer''' event (see example)


=Properties=
<gallery>
*Question - question shown
Image:Ylands-Editor-Dialogue-example1a.png|Properties
*Answer options - list of possible answers, number of option → Id
Image:Ylands-Editor-Dialogue-example1b.png|On Answer
*Show leave button - whenever to show "leave" button or not
Image:Ylands-Editor-Dialogue-example1c.png|Dialogue window
</gallery>


=Events=
= Properties =
*On open - called when dialog start
=== Question ===
*On answered - called when dialog option is selected
*Question displayed in the header of the dialogue
*On closed - called when leave button clicked
=== Options ===
*List of possible answers
*Number in the header of the option → answer Id
=== Show leave button ===
*Whenever to show "leave" button in the Dialogue window.


=Instructions=
= Dialogue events =
*Show dialog - opens dialogue window
*[[Ylands:Tile - Dialogue On Answer|On Answer]]
*Get/Set question - get or set dialogue question
*[[Ylands:Tile - Modal Dialogue On Open-Close|On Open / Close]]
*Get/Set answer text - get or set specific dialogue option by Id
*Get/Set answer enabled - get, enable or disable specific dialogue option by Id


=Literals=
= Related instructions =
*Dialogue - target dialogue game logic
*[[Ylands:Tile - Show dialogue|Show dialogue]]
*Questioner - entity asking question
*[[Ylands:Tile - Dialogue question|Get / Set dialogue question]]
*Player - target player answering dialog
*[[Ylands:Tile - Answer text|Get / Set answer text]]
*Answer id - Id of selected answer (as in properties)
*[[Ylands:Tile - Answer enabled|Get / Set answer enabled]]




{{Game logic list}}
----
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|19}}}}
 
[[Category: Game Logic]]
[[Category: Ylands 0.10]]

Revision as of 17:36, 16 November 2022

Description

When initiated using Show Dialogue instruction, it will display a window of predefined options as defined in properties. After selecting a option On Answer event will be called inside the Dialogue logic. It's possible to show/hide answer options using Answer Enabled instruction, or modify their text.

  • Dialogue between player and world entity (i.e NPC)
  • Initiated via Show Dialog instruction
  • Player selects from pre-defined answers
  • Each answer can call different script instructions
  • Selected answer is obtained via Answer Id in On Answer event (see example)

Properties

Question

  • Question displayed in the header of the dialogue

Options

  • List of possible answers
  • Number in the header of the option → answer Id

Show leave button

  • Whenever to show "leave" button in the Dialogue window.

Dialogue events

Related instructions