A little list of some known script functions used in DATE A LIVE: Rio Reincarnation
A lot of assumptions are being used in this list which could be wrong and please use common sense when using this list.
Exits the script and returns to Title
Example:
Exit()Halts until delay milliseconds has passed
Example:
// Waits for 1 second
Wait(60)Sets the Instruction Pointer to location
Example:
// Jumps to label
Goto(LABEL_063F)
or
// Jump to position (0x3C is the location of the first instuction)
Goto(0x3C)Randomly picks a location in the locations array and sets the Instruction Pointer to it
Example:
// In this example the game will randomly pick any one of the 5 locations and jump to it
RandJump(LABEL_0611, LABEL_063F, LABEL_066D, LABEL_069B, LABEL_06C9)Unused, Might be used to output text on debug builds
Example:
// Writes "TESTSCRIPT" into the console if enabled
Printf("TESTSCRIPT")Loads and jumps to the start of a language script file file
Note: file is an absoute path inside of the PCK and must not contain an extension
Example:
// In this example the game will load Data/{language}/Script/Script.pck/3rd/digest03.bin and start execution at the start of the file
FileJump("3rd/digest03")Calls a function(Sub) by storing the address of the next instruction into the stack and setting the Instruction Pointer to location
Note: Make sure at the end of the function to call CallReturn()
Example:
// Calls the Sub with the name of SUB_089B
Call(SUB_089B)Sets the Instruction Pointer to the address after the Call
Note: Must be used at the end of a function(Sub)
Example:
// Nothing else to say, its like a normal return keyword
CallReturn()Plays language movie file from Data/{language}/Movie/movieName.movie
Note: movieName is relative to the language movie folder and must not contain the extension
Example:
// Plays Opening theme Data/{language}/Movie/3rd_op.movie
PlayMovie("3rd_op", 1, 0)Plays sound effect from Data/Se.pck/soundFXID:D4.snd
Note: If loop is set to true, You will need to call SeStop(Byte, Byte) to stop the playback
Example:
SePlay(158, 0, false)
or
SePlay(126, 0, true)Stops playback of soundFXID
Example:
SeStop(126, 0)Writes text at the position of positionX and positionY and the message is tracked using messageID
Note: The unit for both position is half a pixel on a 1920x1080 screen e.g. 960 is 1920 pixels
Note: This does not include waiting for user input, That job is for MesWait()
Note: You can use MesDel() instead if you only want to clear the textbox without waiting.
Example:
// Writes "Y-You can't come... If you're with me,
even you will..." to the textbox
Mes(80, 423, "Y-You can't come... If you're with me,\neven you will...", 18)Waits for user input or continue if skip is enabled, After called, the next Mes(Byte, Bool, Byte, Bool, String, Int16) call will reset all the text
Note: This should be used after Mes(Byte, Bool, Byte, Bool, String, Int16) to let time for readers to read
Example:
// Waits for user input or skip if skipping is enabled
MesWait()Sets the title of the dialogue to characterNameID
Note: Use of CharacterNames Macros are allowed which can be found in STSCMacros.cs
Note: To disable titles, use the id of 255 or CHAR_NONE
Example:
// Shows YAMAI on the title of the message box
MesTitle(0x32)
or
// Shows YAMAI on the title of the message box (same as above but with a macro)
MesTitle(CHAR_YAMAI)
or
// Disables the title of the message box
MesTitle(CHAR_NONE)Adds a choice option with the text text, When Selected with ShowChoices(Bool) the game will jump to its location. choiceID is used to track if the option has been used
Note: This must be used before ShowChoices(Bool) is called for choices to appear
Example:
// Adds "Go on a date with the Origami." and "Go on a date with the Yamai Sisters."
// to the list of options.
SetChoice(LABEL_063F, "Go on a date with the Origami.", 0)
SetChoice(LABEL_066D, "Go on a date with the Yamai Sisters.", 1)Displays a list of choices and waits for the user to pick a choice, and jumps to the selected choice's location
Note: After the user chooses an option, the choices list is then reset, ready for the next calls of SetChoice(Pointer, String, Int16)
Example:
// Adds two choices to the list
SetChoice(LABEL_017D, "Start from prologue.", 0)
SetChoice(LABEL_0128, "Skip prologue.", 1)
// Displays the choices and waits for a selected option, and jumps to its location
ShowChoices(true)Sets the current font size to fontSize. Size 52 is common throughout the whole game
Note: You should always call this atleast once at the start of the script to ensure text is shown correctly
Example:
// Sets the font size to 52 which is common
SetFontSize(52)
or
// Sets the font size to 104 which is twice as large as the common size
SetFontSize(104)Loads voice file name and plays it once
Note: name is a relative path inside of the game folder in the Voice PCK and must not contain the extension
Example:
// In the example when playing RR (3rd) the game will load Data/Voices.pck/3rd/900_00_00_136_23.snd
// when playing RU the folder name is 1st, AI is 2nd and RR is 3rd
PlayVoice(255, 0, "900_00_00_136_23")Unlocks Trophy (Achievement). Please do not mess around with this function.
Note: Achievement names are hardcoded in the game's executable, trophyID is used as an index to an array of achievement names
Example:
// This will unlock the "Start of Eden" Trophy
Trophy(1)