Messanging, Campaign, Sound¶

← EXE Functions · code catalog

Friendly names for EXE category 3. Each maps to a top-level EXE code.

OldStyleMessage¶

OldStyleMessage(regime1: int, regime2: int, backpic: int, frontpic: int, text: string) · exe 2

Is depreciated. Avoid using it

Parameters

regime1 (int) — Regime1
regime2 (int) — Regime2
backpic (int) — BackPic#
frontpic (int) — FrontPic#
text (string) — Text / DataString payload

Example: exe(2,4,4,1,1,'Example Text')

Load¶

Load(text: string) · exe 7

No in-game description provided; behaviour inferred from the function name.

Parameters

text (string) — Text / DataString payload

Example: exe(7,'Example Text')

Message¶

Message(regime1: int, regime2: int, overwriteScndesc0: int, eventPicNr: int, text: string) · exe 11

if reg1=-1 and reg2=-1 then message is send to all regimes.

Parameters

regime1 (int) — Regime1
regime2 (int) — Regime2
overwriteScndesc0 (int) — Overwrite scndesc >0=yes
eventPicNr (int) — Event Pic Nr (-1=none)
text (string) — Text / DataString payload

Example: exe(11,4,4,1,1,'Example Text')

LoadUnitTransfer¶

LoadUnitTransfer(regime: int, areaslot: int, maxPerHex: int) · exe 69

No in-game description provided; behaviour inferred from the function name.

Parameters

regime (int) — Regime #
areaslot (int) — AreaSlot #
maxPerHex (int) — Max Per Hex

Example: exe(69,4,1,10)

PlayEventWav¶

PlayEventWav(text: string) · exe 89

Adds a sound file from the sound directory to the next ExecMessage, it will be played when the message is actually shown. So the effect is synchronized.

Parameters

text (string) — Text / DataString payload

Example: exe(89,'Example Text')

LoadCampaignRoomBackground¶

LoadCampaignRoomBackground(eventPictureToBeUsed: int) · exe 90

No in-game description provided; behaviour inferred from the function name.

Parameters

eventPictureToBeUsed (int) — Event Picture# to be used

Example: exe(90,1)

SetCampaignRoomTitle¶

SetCampaignRoomTitle(text: string) · exe 91

No in-game description provided; behaviour inferred from the function name.

Parameters

text (string) — Text / DataString payload

Example: exe(91,'Example Text')

PlayEventBackgroundWav¶

PlayEventBackgroundWav(text: string) · exe 92

Loads the sound file from the sound directory and plays it immediatly.

Parameters

text (string) — Text / DataString payload

Example: exe(92,'Example Text')

SetMessageStyleDEPRECIACTED¶

SetMessageStyleDEPRECIACTED(messageStyle: int, text: string) · exe 103

The specified style will be used for the remainder of this event. 0=normal. 1=black, 2=text cloud+black. It also allows you to set an optional footnote (messageNote1). only shown in style 1 + 2. Directly under the main message in italics. SetMessageStyle is used by DC1 and an earlier prototype, kept here for backwards compatibility. The variable it accesses will also be used by DC3's new ExecDynamicMessage which will put it to value 3..

Parameters

messageStyle (int) — Message Style (0,1,2)
text (string) — Text / DataString payload

Example: exe(103,1,'Example Text')

SetMessageNote2¶

SetMessageNote2(text: string) · exe 104

Sets a string for underwriting of picture of character with text cloud. Shown in style 2.

Parameters

text (string) — Text / DataString payload

Example: exe(104,'Example Text')

LoadHistoricalTransfer¶

LoadHistoricalTransfer(regime: int) · exe 142

No in-game description provided; behaviour inferred from the function name.

Parameters

regime (int) — Regime #

Example: exe(142,4)

DynamicMessage¶

DynamicMessage(regime1: int, regime2: int, messageString: string, eventpicture: int) · exe 239

This is the new DynamicMessage. It allows advanced scripting and utilises system graphics 3 background parts. if reg1=-1 and reg2=-1 then message is send to all regimes. (inside note: Dynamic Message sets a message to Style=3 to notify the engine it uses dynamic message mode and advanced scripting)

Parameters

regime1 (int) — Regime1
regime2 (int) — Regime2
messageString (string) — Message String
eventpicture (int) — EventPicture (-1=none)

Example: exe(239,4,4,'Text',1)

SetMessageNameAndGroup¶

SetMessageNameAndGroup(name: string, group: int, hidefromtab: bool, hidefromstart: bool) · exe 240

Will be applied to the next ExecMessage2 or ExecDynamicMessage.

Parameters

name (string) — Name (string not value) Set empty string for no-name!
group (int) — Group (0=none)
hidefromtab (bool) — HideFromTab (1=yes,0=no)
hidefromstart (bool) — HideFromStart (1=yes,0=no)

Example: exe(240,'Name',1,1,1)

PlayEventBackgroundWav2¶

PlayEventBackgroundWav2(fullFilePathRelativeToTheGameExecutable: string) · exe 252

Loads the sound file.

Parameters

fullFilePathRelativeToTheGameExecutable (string) — Full file path relative to the game executable

Example: exe(252,'Text')

WritePDF¶

WritePDF(string: string, filename: string, title: string) · exe 257

The String should be coded like a dynamic message. Pagebreaks are not automatic. You need to use CheckDynamicTextHeight() to predict sizes. Pages are 595 x 842 points. Filename should be without file extension. for example 'doc' or 'oobfile'. Title is displayed as a watermarkish thing on each page on top and pagenumber in the bottom.

Parameters

string (string) — String
filename (string) — Filename
title (string) — Title

Example: exe(257,'Text','Name','Text')

AddNoteToMes¶

AddNoteToMes(textToAdd: string) · exe 362

Used in DC5 to keep pairs for hardcoded Reps

Parameters

textToAdd (string) — Text to add

Example: exe(362,'Text')