TeaScript Syntax

WIP documentation of TeaScript. Feel free to add any information necessary below.

Data Types

Teascript only offers two data types. These are doubles and strings.

Double

Doubles are represented as numbers. This includes whole and decimal numbers. (IEEE 64-bit 8-bytes,-1.79769313486232×10308 to -4.94065645841247×10-324 for negative values,4.94065645841247×10-324 to 1.79769313486232×10308 for positive values) variables.

Double variables can be accessed with the following methods:

'Local
val(myVar) or v(myVar)

'Global
gval(myVar) or gv(myVar)

'Local Concatenation in TXTCreate
&val(myVar)

'Global Concatenation in TXTCreate
&gval(myVar)

String

Strings are represented as text. You can create a string by surrounding text with quotation marks. "Example"

'Local
str(myVar)

'Global
gstr(myVar)

'Local Concatenation in TXTCreate
$val(myVar)

'Global Concatenation in TXTCreate
$gval(myVar)

Other

TeaScript.vbs also lists SMBX Event, Layers, and Scripts as pseudo data types. This data cannot be stored in a variable. This data is used by typing the name of the object without quotation marks in appropriate functions.

Variables

Variables can be manipulated in the following ways.

All variables must be created using the variable interface (found using ctrl+i in the editor)

• Local variables are created in the level editor mode and only exist in the level it was created. Local variables reset every time the level start.
• Global variables are created in the world editor mode and exist throughout the entire episode. Global variables are saved even after level-death or when you quit the episode.

'To set and get the value of a variable
'(myVar1 and myVar2 are local variables)

v(myVar1) = 1
v(myVar2) = v(myVar1) + 1
v(myVar1) = 5
'myVar1 is 5 and myVar is 2

str(myVar1) = "Hello"
str(myVar1) = str(myVar1)&", how are you?" 
'myVar is "Hello, how are you?"

Expressions

Mathematical Symbols

Mathematical Symbols
Symbol	Name	Example
+	Addition	12 + 3 + 5 'returns 19
-	Subtraction	12 - 3 - 5 'returns 4
*	Multiplication	12*2*5 'returns 120
/	Division	'Note that division by 0 will crash SMBX 12/2/5 'returns 1.2
\	Division with no remainder	'Note that division by 0 will crash SMBX 12\2\5 'returns 1.2
^	Power	'Note that 0^0 will return 1 12^2 'returns 144
mod	Modulus	12 mod 5 'returns 2
&	Concatenation	"ABC"&";"&"123" 'returns "ABC;123"
( )	Parenthesis	12*(2 + 5) 'returns 84

Mathematical Functions

These are the mathmatical function provided.
Parameters with #param mean that the parameter is a double.
Parameters with "param" mean that the parameter is a string.

Functions
Name and Parameters	Return Type	Description and Example
abs(#num)	Double	Returns the absolute value of a number abs(-3) 'returns 3
exp(#num)	Double	Returns the number to the power of the e constant exp(5) 'returns e^5
log(#num)	Double	Returns the log of the number with a base of e log(e) 'returns 1
sgn(#num)	Double	Returns the sign of the number (1, -1, or 0) sgn(10) 'returns 1 sgn(0) 'returns 0
int(#num)	Double	Returns the number rounded up. Similar to the common ceiling function int(2.1) 'returns 3
fix(#num)	Double	Returns the number rounded down. Similar to the common floor function int(2.9) 'returns 2
sqr(#num)	Double	Returns the square root of a number sqr(9) 'returns 3
sin(#num)	Double	Returns the sine of the number. Uses radians sin(pi) 'returns 0
cos(#num)	Double	Returns the cosine of the number. Uses radians cos(pi) 'returns 1
tan(#num)	Double	Returns the tangent of the number Uses radians cos(pi/4) 'returns 1
atn(#num)	Double	Returns the inverse tangent of the number. Uses radians atn(1) 'returns pi/4
getangle(#x, #y)	Double	Returns the angle (from 0 to 1) formed between the triangle. Similar to the common atan2 function. getangle(1, 0) 'returns 0 getangle(1, 1) 'returns .125 getangle(0, 1) 'returns .25 getangle(-1, 0) 'returns 0.5 getangle(0, -1) 'returns 0.75
rgba(#red, #green, #blue, #alpha)	Double	Returns an SMBX color value. Parameters must be between 0 and 255 rgba(255, 255, 255, 255) 'returns -1
round(#num, #decimal_place)	Double	Returns the number rounded decimal_place The decimal place rounded to round(1.3456, 2) 'returns 1.35
len("txt")	Double	Returns the length of the text len("ABC") 'returns 3
left("txt", #len)	String	Returns the text cropped starting with the length provided. The crop begins from the start
right("txt", #len)	String	Returns the text cropped starting with the length provided. The crop finished with the end
mid("txt", #len)	String	Returns the text cropped starting with the length provided. The crop begins with the number provided.
replace("txt", "search", "replacement", #start, #count, #case_insensitive)	String	Replaces a part of the text with a new one. start Where in the txt should the search start count The number of replacements. Set to -1 to disable case_insensitive Set to 1 to make the search case-insensitive, otherwise use 0
asc("character")	Double	Returns the ANSI code. It will use the first character if more than one is passed
chr(#code)	String	Returns a string using the ANSI code. Accepts 0-255
ascw("character")	Double	Returns the unicode code. It will use the first character if more than one is passed
chrw(#code)	String	Returns a string using the unicode code. Accepts 0-65535
cstr(#num)	String	Converts the number to a string
cdbl("txt")	Double	Converts the string into a number
instr(#start, "string1", "string2")	Double	To return the point of the first appearance of a given string in another string. start To specify the start point of the search string1 The original string string2 The string to be searched

Special numbers

You can use these special values as they were numbers.

Special Values
Name	Value
pi	3.141592654
e	2.71828182
rnd	A random number between 0 and 1

Comparing and Logical Operators

Symbol	Name	Example
Equal	=	5 = 4 + 1 => (1)true
Not Equal	<>	5 <> 3 => (1)true
Greater than	>	5 > 3 => (1)true
Less than	<	4 < 5 => (1)true
Greater than or equal to	>=	5 >= 5 => (1)true
Less than or equal to	<=	3 <= 3 => (1)true

The logical operators in Teascript are: not, and, or, xor, eqv, and imp.

P	not P
0	1
1	0

P	Q		P and Q	P or Q	P xor Q	P eqv Q	P imp Q
0	0		0	0	0	1	1
0	1		0	1	1	0	1
1	0		0	1	1	0	0
1	1		1	1	0	1	1

Control Flow

If statements

if [conditon] then
  'statement that should run if the first condition is true
elseif [condition] then
  'statement that should run if the other condition is true
else
  'statement that should run if all the other conditions are false
end if

Select Case

Select Case lets you easily organize the control flow by a value.

select case v(var)
  case 0 to 1
    'Script that should pass if v(var)'s value is between 0 and 1.
  case 2
    'Script that should pass if v(var)'s value is exactly 2.
  case else
    'Script that should pass if v(var)'s value does not match any of the other conditions.
end select

Do Loop

There are three different versions of do loops: While loops, Until Loops, and Pure Loops.

'Pure loop:
do
  'this loop will run infinitely until it hits an "exit do" statement
loop

'While Loop:
do while [condition]
  'this loop will run as long as the condition returns true
loop while [condition]

'Until Loop:
do until [condition]
  'this loop will run until the condition returns true
loop until [condition]

With while and until loops, you may choose where to place the 'while' or 'until' keyword. There can only be one of either keyword in the entire loop.

Goto

Using goto it will force the script to jump to the specified line using a label.

Example:
[statements]
goto Example

When the script reached "goto Example" it will jump to "Example" and execute the script below it. The labels used with goto statements must: have names that do not contain characters that do not follow variable name rules and there must not be two labels with the same name.

Script

Using the script keyword, it allows you to make a function in Teascript. Example:

script name(myParam as double, return double)
  return param(myParam) + 1
end script