Functions (TeaScript)
AudioSet
This function allows you to play sound effects, or play/stop music.
To load a sound effect:
call AudioSet(1, ID, Advanced, Filepath)
Parameters | Description |
---|---|
ID | The sound effect ID. Can be between 0-1024. |
Advanced | Whether only one 'copy' of this sound effect can be played in the same time. |
Filepath | The filename of the sound file. The sound file must be in the world map folder. |
To play a sound effect:
call AudioSet(2, ID, 0, "")
Parameters | Description |
---|---|
ID | The ID of the sound effect. Can be between 0-1024. |
To stop a sound effect:
call AudioSet(3, ID, 0, "")
Parameters | Description |
---|---|
ID | The ID of the sound effect. Can be between 0-1024. |
To play music:
call AudioSet(11, FadeIn, 0, Filepath)
Parameters | Description |
---|---|
FadeIn | The duration of the fade-in effect in milliseconds. |
FilePath | The filename of the music file. The sound file must be in the world map folder. |
To stop music:
call AudioSet(12, FadeOut, 0, "")
Parameters | Description |
---|---|
FadeOut | The duration of the fade-out effect in milliseconds. |
EXEScript
This function is used to execute a script. When this function is called, the given script will immediately be executed and the original script will be halted until the execution of the given script completes.
call EXEScript(ScriptName)
Parameters | Description |
---|---|
ScriptName | The script that should be executed. |
Debug
This function will output a string to the debug box. It will only work in the editor, and will not do anything in game mode. It is recommended to delete these functions after debugging for better performance.
call Debug(String)
Parameters | Description |
---|---|
String | The string that should be outputted. |
FXCreate
This function is used to create an effect.
call FXCreate(ID, X, Y, Xsp, Ysp, Frames, AnimationSpeed, Const, Gravity, Advanced)
Parameters | Description |
---|---|
ID | The effect-ID of the effect to create. |
X | The X-scene coordinate where the effect will be created. |
Y | The Y-scene coordinate where the effect will be created. |
Xsp | The X-speed of the effect. |
Ysp | The Y-speed of the effect. |
Frames | The number of frames the effect should last. |
AnimationSpeed | The number of frames each animation frame will last. |
Const | UNKNOWN, default 0 |
Gravity | Should the effect be affected by Gravity?
|
Advanced | UNKNOWN, default 0 |
HUDSet
This function allows you to draw your own HUD. The function serves different purposes with the first parameter.
To erase previous HUD data and initialize the HUD system:
call HUDSet("initialize", 0, 0, 0, 0, 0, 0, 0, 0, 0)
To disable the custom HUD system and erase all the previous custom HUD data.
call HUDSet("destroy", 0, 0, 0, 0, 0, 0, 0, 0, 0)
To add a bitmap to the HUD:
call HUDSet("bitmap", ID, XSource, YSource, Width, Heigth, X, Y, Advanced, Color)
The image source must be in a file called 'scflash.png'.
Parameters | Description |
---|---|
ID | The ID used to identify the HUD bitmap (shares ID with non-HUD bitmaps). |
XSource | The X-position of the top-left point in scflash.png. |
YSource | The Y-position of the top-left point in scflash.png. |
Width | The width of the cropped bitmap. |
Height | The height of the cropped bitmap. |
X | The X-scene coordinate where the bitmap will be created. |
Y | The Y-scene coordinate where the bitmap will be created. |
Advanced | The advanced settings of the HUD bitmap.
|
Color | A certain color. The default value is -1 and type 0 to make the bitmap completely transparent. |
To add text to the HUD:
call HUDSet("text", ID, X, Y, StartASCII, EndASCII, RowASCII, NPCID, Color, -1)
Parameters | Description |
---|---|
ID | The ID of the text. The function will create a new text if the ID is unused, otherwise it will overwrite the existing text. |
X | The x position of the text. |
Y | The y position of the text. |
StartASCII | The starting character code of the font. |
EndASCII | The last character code of the font. |
RowASCII | The number of characters in a row of the font image. |
NPCID | The ID of the NPC ID that contains the font used. |
Color | A certain color. The default value is -1 and type 0 to make the text completely transparent. |
KeyPress
This function returns input data.
KeyPress(ID)
Parameters | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ID | The ID of the input.
|
LMove
This function is used to move layers.
call LMove(LayerName, Xsp, Ysp, Type)
Parameters | Description |
---|---|
LayerName | The name of the layer that you want to move. |
Xsp | The X-distance speed the layer should move (Xsp is difference between original and destination (i.e. value is 32, layer is moved 32 pixels from original coordinate) coordinates if shift movement was used) |
Ysp | The Y-distance the layer should move. (Xsp is difference between original and destination (i.e. value is 32, layer is moved 32 pixels from original coordinate) coordinates if shift movement was used) |
Type | The type of movement that the layer should use.
|
LSet
This function is used to change the visibility of a layer
To Show/Hide/Toggle a layer:
call LSet(LayerName, Type, Smoke)
Parameters | Description |
---|---|
LayerName | The name of the layer that you want to change. |
Type | The type of layer visibility.
|
Smoke | Should there be smoke?
|
To change the alpha value of a layer:
call LSet(LayerName, 38, AlphaValue)
Parameters | Description |
---|---|
LayerName | The name of the layer that you want to change. |
Alpha Value | The alpha value of the layer. This value must be between 0-255. |
LSpin
This function is used to rotate layers. This function only affect NPCs and Blocks.
call LSpin(LayerName, Xcenter, Ycenter, Speed)
Parameters | Description |
---|---|
LayerName | The name of the layer that you want to spin. |
Xcenter | The X-scene coordinate of the center of the circle. |
Ycenter | The Y-scene coordinate of the center of the circle. |
Speed | The spin speed. Positive values spin anti-clockwise and negative values spin clockwise. |
NCreate
This function is used to spawn an NPC. The function returns the permanent id of the spawned NPC.
call NCreate(ID, X, Y, Xsp, Ysp, Advance, CreationData)
'If you want the permanent id of the spawned NPC, do:
v(myVar) = NCreate(ID, X, Y, Xsp, Ysp, Advset, CreationData)
Note that the spawned NPC becomes active until the next frame.
Parameters | Description |
---|---|
ID | The NPC-ID that should be spawned. |
X | The X-coordinate of the spawned NPC. |
Y | The Y-coordinate of the spawned NPC. |
Xsp | The X-Speed of the spawned NPC. |
Ysp | The Y-Speed of the spawned NPC. |
Advance | The "advset" field of the spawned NPC. |
CreationData | Related to generators? UNKNOWN |
PlayNote
This function is used to play a note.
call PlayNote(Command)
Parameters | Description |
---|---|
Command | The command can be:
Patch = ID of the instrument (0-127) Volume = The volume of the note (0-100) Flip = The pitch of the note (0-255) Channel = The channel of the note (0-15) Default:0 |
ShowMsg
This function shows a message using a message box.
call ShowMsg(Message)
Parameters | Description |
---|---|
Message | The message that will be shown. It must be a string. |
Sleep
This function is used to pause the script for a number of frames. It can only be used in scripts called through an event.
call sleep(Delay)
Parameters | Description |
---|---|
Delay | The number of frames the script should be paused. |
SpEvent
This function is used to trigger special events.
call SpEvent(ID)
Parameters | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ID | The ID of the special event. Can be seen by right clicking the special event menu.
|
SysShowInput
Will show a message box that has a text box.
call SysShowInput(Message, Title)
'If you want the written text, do:
str(myVar) = SysShowInput(Message, Title)
Parameters | Description |
---|---|
Message | The message that is shown in the message. Must be a string |
Title | The title that is shown in the message. Must be a string |
SysShowMsg
Will show a message box with default options.
call SysShowMsg(Message, Type, Title)
'If you want the selected option, do:
v(myVar) = SysShowMsg(Message, Type, Title)
Parameters | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message | The message that is shown in the message. Must be a string | ||||||||||||||||||||||||||||||
Type | The ID of the message box.
This is the ID returned
| ||||||||||||||||||||||||||||||
Title | The title that is shown in the message. Must be a string |
TClear
call TClear(Type, EventName)
Parameters | Description |
---|---|
Type | The clear type
|
EventName | If type is 0, then set the EventName to clear.
If type is 1, then set this to 0. |
TCreate
This function is used to call an event/create an event timer.
call TCreate(EventName, Delay)
Parameters | Description |
---|---|
EventName | The event that should be called. |
Delay | The number of frames until the event is called. |
TCreateEx
This function is used to execute a script after the set delay and pass parameters to the said script.
call TCreateEx(ScriptName, Delay, Param1, Param2, Param3)
Parameters | Description |
---|---|
ScriptName | The script that should be executed. |
Delay | The number of frames until the script is executed. |
Param1 | The value that should be passed to Sysval(Param1). |
Param2 | The value that should be passed to Sysval(Param2). |
Param3 | The value that should be passed to Sysval(Param3). |
TxtCreate
This function is used to create a text object.
call TxtCreate(id, x, y, sasc, easc, cdata, lnum, fontid, flag, text)
Parameters | Description |
---|---|
id | The unique identifier of the text. |
x | x-position of the text. |
y | y-position of the text. |
sasc | the beginning ASCII code of the NPC image font. |
easc | the last ASCII code of the NPC image font. |
cdata | reserved.Type 0. |
lnum | the number of characters of a single row in the NPC image file. |
fontid | ID of the NPC used as the font.Use the numbers in the NPC image filename as the ID. |
flag | 0: coordinates will be oriented to the scene. 1: coordinates will be oriented to the screen. |
text | The text shown. |