scmJS docs

Mission briefing actions

A mission briefing is the screen before a single-player mission: portraits, text and speech, one briefing per player. It is stored in the map's MBRF section, in the same record as a trigger, with the condition Mission Briefing and its own set of actions, numbered separately from a trigger's. Four portrait slots, 0 to 3, hold the portraits. The editor's Triggers ▸ Mission Briefing edits them, and its layout is the one Blizzard's own multiplayer maps carry.

Wait (briefing)#

Holds the briefing for the time.

Briefing action 1 · Wait(Milliseconds);

Argument Takes Stored in the briefing action
Milliseconds a time in milliseconds bytes 12–15

Play WAV (briefing)#

Plays a sound.

Briefing action 2 · Play WAV(WAV, Duration);

Argument Takes Stored in the briefing action
WAV the name of a sound file in the map, stored as a string-table entry bytes 8–11
Duration a time in milliseconds bytes 12–15

Text Message#

Shows the text for the time.

Briefing action 3 · Text Message(Text, Duration);

Argument Takes Stored in the briefing action
Text text, stored as a string-table entry bytes 4–7
Duration a time in milliseconds bytes 12–15

Mission Objectives#

Sets the text of the objectives shown with the briefing.

Briefing action 4 · Mission Objectives(Text);

Argument Takes Stored in the briefing action
Text text, stored as a string-table entry bytes 4–7

Show Portrait#

Shows the unit type's portrait in a slot.

Briefing action 5 · Show Portrait(Unit, Slot);

Argument Takes Stored in the briefing action
Unit a unit type, or one of the unit classes bytes 24–25
Slot a portrait slot, 0 to 3 bytes 16–19

Hide Portrait#

Hides the portrait in a slot.

Briefing action 6 · Hide Portrait(Slot);

Argument Takes Stored in the briefing action
Slot a portrait slot, 0 to 3 bytes 16–19

Display Speaking Portrait#

Makes the portrait in a slot talk for the time.

Briefing action 7 · Display Speaking Portrait(Slot, Duration);

Argument Takes Stored in the briefing action
Slot a portrait slot, 0 to 3 bytes 16–19
Duration a time in milliseconds bytes 12–15

Transmission (briefing)#

Text and a sound with the portrait in a slot talking, as a trigger's Transmission does. No Blizzard map uses it; its layout follows the community's reference and SCMDraft.

Briefing action 8 · Transmission(Text, Slot, Modifier, Amount, Duration, WAV);

Argument Takes Stored in the briefing action
Text text, stored as a string-table entry bytes 4–7
Slot a portrait slot, 0 to 3 bytes 16–19
Modifier Set To, Add or Subtract byte 27
Amount a whole number, 0 to 4,294,967,295 bytes 20–23
Duration a time in milliseconds bytes 12–15
WAV the name of a sound file in the map, stored as a string-table entry bytes 8–11

Skip Tutorial Enabled#

Offers the button that skips the tutorial.

Briefing action 9 · Skip Tutorial Enabled();

It takes no arguments.

scmJS 0.6.2 + main@dd79a77 · Generated from the repository. The source is under the MIT license, which does not cover what ATTRIBUTION.md lists. StarCraft and Brood War are trademarks of Blizzard Entertainment; this project ships none of their data.