Dialogues

Basic description of the dialogue files.

Settings

This section allows you to configure settings specific to dialogues.

Settings:
  typing-speed: 1 # Ticks(Second/20)
  range: 3 # 
  effect: Slowness # Slowness / Freeze
  answer-numbers: true
  prevent-exit: false
  character-name: true
  character-image: true
  background-fog: true

The prevent-exit setting prevents the dialogue from being instant ended using shift.

Pages

Specifies the dialogue pages; you can configure everything here.

Pages:
  '1a':
    lines:
      - 'LuxDialogues is #2d87c3available #4f4a3enow!'
      - 'Have not you #cdff29bought #4f4a3eit yet?'
      - 'What are you waiting for?'
    typing-info-line: 'Right Click To Skip Typing' # Not available
    steady-info-line: 'Right Click to Change Page' # Not available
    goto: '1b' # If this is not empty, answers will be disabled.
    timer: 30 # Not available
    pre-actions:
      - msg %player_name% dialoguepreAction1 @console
    post-actions:
      - msg %player_name% dialoguepostAction1 @console
    exit-actions:
      - msg %player_name% dialogueexitAction1 @console

pre-actions are triggered at the beginning of the dialogue page, while post-actions are triggered at the end. Available arguments here include @console, @delay.<seconds>, and condition.<condition>. A detailed explanation is provided in the following sections of the page.

The maximum number of lines you can use in dialogues is the same as specified in the Pack/Lines/lines.yml file.

Pages With Answers

The selection screen that appears at the end of dialogue pages.

Pages:
  '1b':
    lines:
      - 'New features are added almost'
      - 'every day I think you'
      - 'shouldn''t miss this'
      - 'opportunity...'
    typing-info-line: 'Right Click To Skip Typing'
    steady-info-line: 'Right Click to Change Page'
    goto: '' # If this is not empty, answers will be disabled.
    timer: 30 # Not available
    pre-actions: {}
    post-actions: {}
    exit-actions: {}
    answers:
      '1':
        text: I'm buying it now.
        goto: ''
        reply:
          - '#82d850<3'
        sound:
          id: luxdialogues:luxdialogues.sounds.ding
          source: MASTER
          volume: 1.0
          pitch: 1.0
        actions:
          - msg %player_name% action1
      '2':
        text: Really?
        goto: ''
        condition: :luxdialogues.test:==true
        reply:
          - '#82d850Yes!!'
        sound:
          id: luxdialogues:luxdialogues.sounds.beep
          source: MASTER
          volume: 1.0
          pitch: 1.0
        actions:
          - say That's great!! (Player CMD) @delay.5
      '3':
        text: Eew, no!
        goto: ''
        reply:
          - '#e52b2bI disagree with you, this plugin is amazing!'
        sound:
          id: luxdialogues:luxdialogues.sounds.beep
          source: MASTER
          volume: 1.0
          pitch: 1.0
        actions:
          - msg %player_name% action1 @console

The usage of conditions and actions is explained in the following sections of the page.

You can completely remove this section if you want to create something that only consists of dialogues without any selections.

Gotos

Gotos can be used in both answers and dialogues. You can easily see where you can place them in the sections above.

Gotos allow branching by letting you redirect from one dialogue to another, or from an answer to a different dialogue.

Goto Usage

goto: '1b'

Multiple Goto Usage With Conditions

goto:
- '1b @condition.%placeholder%>5'
- '2b @condition.%placeholder%<=5'

When multiple gotos are used, even if all conditions are met, only the first one written will be taken into account.

If you use a goto in dialogues, the answer section will be ignored even if it exists, and the dialogue will jump to the specified one.

Conditions

There are 2 types of conditions: one for permissions and the other for placeholders.

Permission Conditions

:permission:==true
:permission:!=true

Placeholder Conditions

%placeholder%==true
%placeholder%!=true
%placeholder%>0
%placeholder%<0
%placeholder%>=5
%placeholder%<=5
%placeholder%==5

Actions

Actions can be used in dialogues and answers. The locations where they are used are specified in the texts above. There are several tags you can use for actions. These are exemplified below.

Delayed Action

say test @delay.5 # The specified value is processed in seconds.

Executed As Console

say test @console

Condition

say You're a VIP @condition.:vip.perm:==true

Multiple Condition

say You're a VIP @condition.:vip.perm:==true @condition.:player.perm:==true

Tags can be used together with each other.