text

Description

In a text event, a sequence of text is played, and images can be shown / manupilated.
Text events are the most complicated of all events due to the large number of different commands involved.

Specific Attributes

• "parts" - A series of complex commands which describe the text event
• "disallowSkip" (Boolean) - Whether or not the "skip" button should appear. Default is false (button will appear)

"parts"

• {"sfxx":"aud.mp3" } - play a sound effect from /audio/
• {"bgmx":"aud.mp3" } - replace current background music with a new one from /audio/
• {"text":"String"  } - make text appear in the text box
• {"name":"String"  } - make text appear in the name box
• {"back":"img.webp"} - fadeout the current screen, replace the background, then fade back in
• {"kill":"Layer"   } - erase the specified layer from the event's memory. Can be used eg after a out_fade event.
• {"glow":"#color", "layer":"Layer" } - add a HEX code glow effect to the specified layer.
• {"move":"Layer" , "speed":Number, "dist":Number } - Move the Layer dist % of the screen to the right (left if negative) in speed seconds.


• {"char":"Layer" , args} - Creates / re-uses a char event of the same layer.
  
  
  • Char lets you re-use commands from before in a single line.
  
  
  • args can include:
  
  
  • {"glow":"#color"} (If not specified, it will re-use the last glow for this character)
  • {"name":"String"} (If not specified, it will re-use the last name for this character)
  • {"left": Number } (Have the Layer image start this % of the screen from the left)
  • {"anim":"animId"} (for a list of animations, see below) (you can also specify speed, like in a move event)
  • {"text":"String"}
  
  
  • Examples:
  
  
  • {"char": "demon", "src" : "evil.webp", "name": "Demon", "text": "It's me! A spooky demon!"}
  • {"char": "demon", "text": "I am so evil!"}
  • {"char": "demon", "text": "Mwahahaa!", "anim": "out_fade"}

"anim"

When using "anim" on a "char" command, you can specify one of these animations:

• "out_fly_u"
• "out_fly_d"
• "out_fly_l"
• "out_fly_r"
• "in_fly_u"
• "in_fly_d"
• "in_fly_l"
• "in_fly_r"
• "out_fade"
• "in_fade"
• "blur"
• "unblur"
• "crush"
• "uncrush"
• "flip"
• "unflip"

Example

  "text": {

    "kaibaMeetsDemon": {
      "micon": "area.webp",
      "image": "mansion.webp",
      "parts": [
        play new music
        {"bgmx": "mansion.mp3"},
        just display text
        {"text": "You find yourself in a big scary mansion!"},
        play demon laugh sound effect
        {"sfxx": "laugh.mp3"},
        

        create a new character. The game will remember its "name":"demon". It also appears on screen with the appropriate text, image, and name.
        {"char": "demon",    "src": "evil.webp",    "name": "Demon",    "text": "It's me! A spooky demon!"},
        make the bust image immediately become "norm", without having user click "continue"
        {"char": "demon",    "src": "norm.webp",    "immediate": true},
        move demon 300 pixels right
        {"move": "demon",    "dist": 30,            "speed": 3},
        name will still be "Demon", as it has not yet been overwritten
        {"text": "I shall send you to the shadow realm!"},  
        

        New character - same as before, but on the "kaiba" layer. Also, includes a glow.
        {"char": "kaiba",    "name": "Kaiba",            "glow": "#0000ff",    "src": "kaiba.webp",    "text": "Oh no! Not a demon!"},
        The name is remembered from before. The glow color is new, so it overwrites the previous glow (which was none).
        {"char": "demon",    "text": "Yes, a Demon!",    "glow": "#ff0000"},
        Since the kaiba character already had a name and glow, we can exclude them here.
        {"char": "kaiba",    "text": "Time to duel!"},
        Since the demon character already had a name and glow, we can exclude them here. Also, make the demon fade out.
        {"char": "demon",    "text": "Mwahahaha!",       "anim": "out_fade"}
      ]
    }

  }
    

Text Effects

As of 3.0.1, you can add extra effects, such as color, to text events.

        "color"          - HexCode EG: {{color:#ff0000:This text is red}}
        "bold"           - EG: {{bold::This text is bold}}
        "italic"         - EG: {{italic::This text is in italics}}
        "overline"       - EG: {{overline::This text is overlined}}
        "underline"      - EG: {{underline::This text is underlined}}
        "strikethrough"  - EG: {{strikethrough::This text has a line through it}}
        "tooltip"        - EG: {{tooltip:This will appear when hovering:Over this part of the text}}
      

Further Information (Deprecated)

Previously, campaign creators would need to specify these commands somewhat differently. This functionality is still legal in most cases, but should be considered deprecated.

      {"type":"text", "content": "String"}  - make text appear in the text box
      {"type":"name", "content": "String"}  - make text appear in the name box
      {"type":"sfxx", "content": "xxx.mp3"} - play a sound effect from /audio/
      {"type":"vfxx", "content": "out_fade"} - fade out only the first Layer
    

If the event is a single String, it will be assumed to be a single text command (with no music, no background image, etc). This is only really useful for quick testing.

      "text": {
        "oneLiner" : "this is assumed to be a text event",
        "longerVer": "parts": [{"text": "this is the same as the above event, but longer"}]
      }