🎤 Promos

Required Metadata

title

The title of the promo. Must be a string.

description

The description of the promo. Must be a string. [P1] and [P2] will be replaced with the names of the characters.

characters

The characters in the promo. Must be a comma-separated list of integers, or an integer prefixed by `:`. When using a prefixed integer, an array from 1 to that integer will be created. When using a list, the list will be used as the array. 1 and 2 are the default characters as selected by the user, 3 is another character, -1 is the referee, and 11 and 22 are the tag team partners of 1 and 2 respectively. Other values are not supported.

Optional Metadata

category

The category of the promo. Must be a string. Defaults to `Custom`.

use_names

Whether to use character names in `surprise_entrants`, `speaker`, `target` and commands instead of their ids. Their names can be used even if they are not selected in the `characters` field. Must be True or False. Defaults to False.

surprise_entrants

Sets the given wrestlers (and their managers) as surprise entrants, who will only come out through the curtain once the promo ends. Must be a comma-separated list of match character ids.

next_promo

Sets another custom promo to happen once this one ends. Must be a title of another custom promo. This allows you to have surprise entrants have voice lines once they enter the ring.

career_probability

Sets the probability of this promo happening in wrestler career mode. Must be a string followed by a float and optional parameters. See below for a list of supported settings.

Probability settings:

career_probability: Disabled

Disables the promo in wrestler career mode.
Example: career_probability: Disabled

career_probability: Absolute (probability)

The promo will happen with the given probability whenever no other promo is scheduled.
You can use Absolute! to allow it to override 'basic' vanilla promos (promos that are randomly assigned before the match starts). Note that the ! group is distinct from the absolute group and takes precedence.
Absolute promos take precedence over relative and grouped relative promos.
Example: career_probability: Absolute 0.5

career_probability: Relative (probability)

Relative probability of the promo happening, weighted based on other non-absolute custom promos.
You can use Relative! to allow it to override 'basic' vanilla promos, same as absolute!.
Example: career_probability: Relative 0.5

career_probability: GroupedRelative (probability) (group)

Relative probability of the promo happening, weighted based on other non-absolute custom promos with the same group.
Group can be any string, but it is recommended to prefix it with your author name and mod name to avoid conflicts.
You can use GroupedRelative! to allow it to override 'basic' vanilla promos, same as absolute!.
Note the lack of space in GroupedRelative.
Example: career_probability: GroupedRelative 0.5 MyName_MyMod_MyPromoGroup

Dialog Lines

line1/line2

The dialog line. Must be a string. The quotes are required. For quotes inside the string, you need to escape them with \".

speaker

The id of the character speaking the line. Must be an integer.

target

The id of the character being spoken to. Must be an integer.

taunt

The taunt to use. Must be a string or integer. A list of taunts can be found in Taunts.

demeanor

The demeanor of the character. Must be an integer. A positive value will make the character happy for the given number of frames, and a negative value will make the character angry for the given number of frames.

commands

A list of commands to execute. Must be a list in the format `command:arg1:arg2:arg3...`. Commands are separated by a semicolon. Example: SetFace:1;SetRealFriend:1:2

The following commands are supported:

Commands and names are case-insensitive.

Special Arguments

$name#1, @him/his/etc#1, $promotion#1, etc. are special arguments that will be replaced with the corresponding value.
The full list of special arguments can be found below. Keep in mind that '#1', '#2', etc. should be replaced with the corresponding number or id.

$name#1

The name of the character with the corresponding id.

@him/his/etc#1

The pronoun id, e.g. @his1 friend-> his friend or her friend depending on wrestler #1's gender. Supported pronouns are He, he, His, his, Male, male, Man, man, Guy, guy, Boy, boy

$promotion#1

The name of promotion #1.

$belt#1_#2

The name of promotion #1's belt #2.

$champ#1_#2

The name of promotion #1's champion of belt #2.

$moveFront#1_#2

The name of character #1's front move number #2.

$moveBack#1_#2

The name of character #1's back move number #2.

$moveGround#1_#2

The name of character #1's ground move number #2.

$moveAttack#1_#2

The name of character #1's attack move number #2.

$moveCrush#1_#2

The name of character #1's crush move number #2.

$taunt#1_#2

The name of character #1's taunt number #2.

$location

The name of the current location.

$prop#1

The name of the prop held by character #1.

$stat#1_#2

The value of character #1's stat number #2.

$match

The name of the current match type.

$date(#1)

The current date. The #1 parameter is optional and increases/decreases the date by that many weeks.

The following moves are supported: