Jump to:

BooBoo Core Functionality

The following describe the core functions of BooBoo. All of this can be used from the CLI version as well as the game engine.

Sections:

Core Functions

var

	declare a variable or variables
	e.g. var x y z

reset

	load a different BooBoo script
	This is seamless and more or less instant. If you start drawing
	the same thing in the next script, the player may not know the
	script changed. It's useful for different game modes, menus,
	high scores etc... state information can be passed between scripts
	using the configuration API.
	e.g. reset "next_slide.boo"

exit

	Exit the app with a return code to the environment
	e.g. exit 0

return

	Return a value from a function
	e.g. return 1
	or just return if the function doesn't return a value

include

	Include a BooBoo file at this point in the code
	e.g. include "my_functions.inc"

:

	Define a label
	e.g. :jump_here

;

	Define a comment
	e.g. = x 1 ; assign 1 to x

/* */

	A multiline comment
	e.g. call foo bar /* foo bar */ baz

""

	a string
	e.g. = name "Pelvis Johnson"

function

	define a function
	References can be defined by prefixing a parameter name by a tilde (~)
	e.g. function foo param1 param2 ~param3 { ... }

(typeof)

	Returns a string respresentation of the type of the second parameter
	e.g. = type_string (typeof my_var)

()

	an expression
	e.g. (+ x (* y (* z w 2))) in C would be x+(y*(z*w*2))
	Supported operators are: + - * / % && || > < >= <= == != ! | ^ & << >> @
	The boolean operators return 1 or 0
	Your own functions can be supplied as operators

[]

	Vector/map indexing operator
	e.g. = x [v [m "key"]] in C++ would be x = v[m["key"]]
	Can be used anywhere a variable is expected.
	You can use multiple indexes
	e.g. [v 3 2 1 0] is like v[3][2][1][0] in C.

#

	Start a hexadecimal number
	e.g. #FF is equivalent to 255

~

	A reference. Function parameters preceded by a ~ can be modified
	by a function
	e.g. function foo a b ~c d ~e { ... } ; c and e can be modified

@

	The address operator
	e.g. = my_pointer (@ my_var)
	or
	call foo (@ bar) ; where foo is expecting a pointer

`

	Dereference operator. This is used to get/set the value pointed
	to by a pointer
	e.g. = p (@ some_num)
	e.g. = `p 10 ; some_num is now 10

(toptr)

	You can do some basic "reflection" using toptr to get a pointer
	the to variable with the name in a string.
	e.g. var foo
	e.g. = number 10
	e.g. var bar
	e.g. = bar "foo"
	e.g. = `(toptr bar) 1000 ; foo is now 1000
	You can use this to script BooBoo with function names/etc in a text file.
	Returns NULL if the variable isn't found

(rand)

	random integers between two numbers inclusive
	This uses a Mersenne Twister algorithm
	e.g. = r (rand 0 99)

srand

	Seed the random number generator
	e.g. srand (time)

(time)

	Return time since epoch in seconds
	e.g. = t (time)

=

	assign
	e.g. = x 1

(number)

	Cast to a number
	e.g. = n (number str)

(string)

	Cast to a string
	e.g. = str (string num)

(vector)

	Cast to a vector
	e.g. var foo
	e.g. = foo (vector foo)

(map)

	Cast to a map
	e.g. var foo
	e.g. = foo (map foo)

(function)

	Cast to a function
	e.g. var foo
	e.g. = foo (function foo)

(label)

	Cast to a label
	e.g. var foo
	e.g. = foo (label foo)

(pointer)

	Cast to a pointer
	e.g. var foo
	e.g. = foo (pointer foo)

Flow Control

goto

	jump to a label
	e.g. goto next_loop

?

	Comparison
	e.g. ? x 1
	You can also evaluate an expression
	? 1 (&& (> a b) (< x y)) je true jne false

je

	Jumps like this one are based on the last comparison. If it was equal,
	this will jump, if not, it won't
	e.g. je process_x_equals_1

jne

	Jump if not equal
	e.g. jne process_x_not_1

jl

	Jump if less
	e.g. jl my_label

jle

	Jump if less or equal
	e.g. jle my_label

jg

	Jump if greater
	e.g. jg my_label

jge

	Jump if greater or equal
	e.g. jge my_label

call

	Call a function that doesn't return anything
	e.g. call my_func param1 param2 param2

call_result

	Call a function that returns a value
	e.g. call_result result my_func param1 param2

if

	compare and jump
	e.g. if (expr1) the_if (expr2) elseif1 (expr3) elseif2 the_else
		; expr1 true code
	:the_if
		; expr2 true code
	:elseif1
		; expr3 true code
	:elseif2
		; else code
	:the_else

	the_if elseif1 elseif2 and the_else are labels that are the bottom of
	their code blocks. The else block is optional. Labels need to be in
	order of appearance in the if statement or behaviour is undefined.

for

	A for loop
	e.g. for i start (expression) increment end_label
		; your loop code here
	:end_label
	i is initialised to "start" then gets incremented
	by increment each loop until expression returns
	FALSE.

String Functions

(string_format)

	format strings with replacements
	e.g. = dest (string_format "I'm % years old" age)
	printf-equivalent formating options are available with %(...) for
	example %(3.16g)

(string_char_at)

	Get the value of character at index in a string
	This function is UTF8 compliant
	e.g. = dest (string_char_at str index)

(string_length)

	Get the length of a string
	This function is UTF8 compliant
	e.g. = dest (string_length str)

(string_from_number)

	Turns the ascii value into a one character length string
	This function is UTF8 compliant
	e.g. = str (string_from_number 97) ; creates "a"

(string_substr)

	Create a substring of a string
	e.g. = s (string_substr s start end)
	End is optional, if not specified it will cut from start till the
	end of the string.
	This is UTF8 compliant

(string_uppercase)

	Make a string uppercase
	e.g. = s (string_uppercase s)

(string_lowercase)

	Make a string lowercase
	e.g. = s (string_lowercase s)

(string_trim)

	Trim leading and trailing whitespace from a string
	e.g. = s (string_trim s)

(string_replace)

	regex replacement
	e.g. = str (string_replace str regex replacement)

(string_match)

	Extract sub-strings from a string
	e.g. = out_vector (string_match str regex)

(string_matches)

	Check if a string matches a regex
	e.g. = yesno (string_matches str regex)

Math Functions

(fmod)

	floating point modulus
	e.g. = x (fmod x 1.5)

(sin)

	trigonometry functions
	e.g. = n (sin n)

(cos)

	trigonometry functions
	e.g. = n (cos n)

(tan)

	trigonometry functions
	e.g. = n (tan n)

(asin)

	trigonometry functions
	e.g. = n (asin n)

(acos)

	trigonometry functions
	e.g. = n (acos n)

(atan)

	trigonometry functions
	e.g. = n (atan n)

(atan2)

	trigonometry functions
	e.g. = n (atan2 y x)

(abs)

	absolute value
	e.g. = n (abs value)

(pow)

	exponentiation
	e.g. = n (pow x 2)

(sqrt)

	square root
	e.g. = n (sqrt x)

(hypot)

	Calculate hypotenuse of a and b
	e.g. = n (hypot a b)

(floor)

	Drop the fractional part of a number
	e.g. = n (floor x)

(ceil)

	Round to the next highest integer
	e.g. = n (ceil x)

(neg)

	Invert the sign of a number
	e.g. = n (neg x)

(sign)

	Returns the sign of a number
	e.g. = n (sign x)

(exp)

	Calculate the value of e
	e.g. = n (exp x)

(log)

	Logarithm function
	e.g. = n (log x)

(log10)

	Base 10 logarithm
	e.g. = n (log10 x)

(min)

	Get the minimum number in a list of values
	e.g. = n (min a b c d e f g)

(max)

	Get the max number in a list of values
	e.g. = n (max a b)

Vector and matrix math

	Some vector and matrix math is available through expression
	operators. Supported are: mul, identity, scale, rotate,
	translate, length, dot, angle, cross, normalize, add, sub,
	inverse, transpose
	Most of these behave as you'd expect. identity takes 1 argument,
	the size of the matrix. scale, rotate and translate produce
	transformation matrices to be multiplied by another matrix
	(scale and translate take 3 parameters, rotate takes 4.)

Vector Functions

vector_add

	push a value onto a vector (must be created e.g. vector v)
	e.g. vector_add v 0

(vector_size)

	get the number of elements in a vector
	e.g. = size (vector_size vec)

vector_insert

	insert a value in any position in a vector
	e.g. vector_insert v index value

vector_erase

	remove from a vector
	e.g. vector_erase v index

vector_clear

	empty a vector
	e.g. vector_clear v

vector_reserve

	Allocate space for at least n elements to avoid reallocations
	e.g. vector_reserve v n

explode

	Assign sequential vector elements to variables
	e.g. var v
	e.g. vector_init v 1 2 3 4 5
	e.g. var a b c
	e.g. explode v a b c ; 1 2 3 in a b c

Map Functions

map_erase

	erase a key/value pair from a map
	e.g. map_erase m "key"

map_clear

	clear a map
	e.g. map_clear m

(map_keys)

	Get the names of the keys from a map into a vector of strings
	e.g. = v (map_keys m)

File Functions

(file_open)

	open a file, mode can be either "a" "r" or "w"
	"a" means append, "w" means write (overwrite)
	and "r" means read mode.
	e.g. var f
	e.g. = f (file_open "out.txt "w")
	f will be -1 on failure

file_close

	You should always close files you open with this
	e.g. file_close f

(file_read)

	Read a word from a file
	e.g. = s (file_read f)

(file_read_line)

	Read a line from a file
	e.g. = s (file_read_line f)

file_write

	Write a word to a file
	e.g. file_write f "turkey"

file_print

	Print to a file. Behaves exactly like print but takes a file
	e.g. file_print f "%(20s)%(20s)%(20s)" x y z

Other

print

	print a string (like string_format)
	e.g. print "Hello, I'm % and I like % and %" name like1 like2
	printf-equivalent formating options are available with %(...) for
	example %(3.16g)

(input)

	Read a word from stdin
	e.g. = str (input)

(getenv)

	Get an environment variable
	e.g. = dest (getenv "HOME")

mkdir

	Create a directory
	e.g. mkdir my_string_path

(list_directory)

	List files and directories in a glob
	e.g. = dest_vector (list_directory "/home/Pelvis/*")
	Directories returned will end with "/" and regular files will not.

(get_system_language)

	Returns the user interface language of the system
	e.g. = lang (get_system_language)
	lang will be in Steam format e.g. "french", "brazilian" etc

(list_drives)

	Get a list of active drive letters in a vector (e.g. "A", "C", ...)
	e.g. = v (list_drives)

(get_full_path)

	Convert a pathname to a fully qualified pathname
	e.g. = filename (get_full_path filename)

text_colour

	Change the text colour. Colour constants are:
		BLACK
		BLUE
		GREEN
		CYAN
		RED
		PURPLE
		YELLOW
		WHITE
	Each colour has a bright version toggleable by a boolean.
	e.g. text_colour BLACK 0 WHITE 1 ; fore fore_bright back back_bright

text_reset

	Reset the text colour
	e.g. text_reset

text_clear

	Clear the screen
	e.g. text_clear

(getch)

	Input a single character from the terminal, not waiting for newline
	e.g. = input_number (getch)

Constants

Note: these values are not read-only (so not technically constant...)

These are used with text_colour: