Script language
The HS language itself: the special forms that sequence and branch scripts, the arithmetic and comparison operators, the sleep family, casts between object types, and printing. Everything else in the table is the engine API these forms call into.
- Functions
- 62
- Work in this build
- 62
- Compiled out
- 0
62 names
- -
- !=
- *
- /
- %
- +
- <
- <=
- =
- >
- >=
- abs_integer
- abs_real
- and
- begin
- begin_count
- begin_random
- begin_random_count
- bit_test
- bit_toggle
- bitwise_and
- bitwise_flags_toggle
- bitwise_left_shift
- bitwise_or
- bitwise_right_shift
- bitwise_xor
- branch
- breakpoint
- cinematic_sleep
- cond
- device
- evaluate
- get_executing_running_thread
- if
- inspect
- kill_active_scripts
- kill_thread
- list_count
- list_count_not_dead
- list_get
- log_print
- max
- min
- not
- or
- pin
- print_if
- random_range
- real_random_range
- scenery
- script_finished
- script_started
- set
- sleep
- sleep_forever
- sleep_until
- sleep_until_game_ticks
- unit
- vehicle
- wake
- weapon
-
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (- <number> <number>) | real | 10 |
console: blam (- <number> <number>)
Called 71 times by the shipped campaign scripts, with 2 arguments.
!=
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (!= <expression> <expression>) | boolean | 17 |
console: blam (!= <expression> <expression>)
Called 68 times by the shipped campaign scripts, with 2 arguments.
*
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (* <number(s)>) | real | 11 |
console: blam (* <number(s)>)
Called 255 times by the shipped campaign scripts, with 2 arguments.
/
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (/ <number> <number>) | real | 12 |
console: blam (/ <number> <number>)
Called 18 times by the shipped campaign scripts, with 2 arguments.
%
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (% <number> <number>) | real | 13 |
console: blam (% <number> <number>)
Called 5 times by the shipped campaign scripts, with 2 arguments.
+
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (+ <number(s)>) | real | 9 |
console: blam (+ <number(s)>)
Called 557 times by the shipped campaign scripts, with 2 to 6 arguments.
<
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (< <number> <number>) | boolean | 19 |
console: blam (< <number> <number>)
Called 660 times by the shipped campaign scripts, with 2 arguments.
<=
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (<= <number> <number>) | boolean | 21 |
console: blam (<= <number> <number>)
Called 785 times by the shipped campaign scripts, with 2 arguments.
=
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (= <expression> <expression>) | boolean | 16 |
console: blam (= <expression> <expression>)
Called 2,646 times by the shipped campaign scripts, with 2 arguments.
>
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (> <number> <number>) | boolean | 18 |
console: blam (> <number> <number>)
Called 1,149 times by the shipped campaign scripts, with 2 arguments.
>=
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (>= <number> <number>) | boolean | 20 |
console: blam (>= <number> <number>)
Called 906 times by the shipped campaign scripts, with 2 arguments.
abs_integer
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (abs_integer <long>) | long | 38 |
console: abs_integer <long>
abs_real
→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (abs_real <real>) | real | 39 |
console: abs_real <real>
Called 1 time by the shipped campaign scripts, with 1 argument.
and
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (and <boolean(s)>) | boolean | 7 |
console: blam (and <boolean(s)>)
Called 897 times by the shipped campaign scripts, with 2 to 20 arguments.
begin
special formEvaluates each expression in order and returns the value of the last.
| Signature | Returns | Slot |
|---|---|---|
| (begin <expression(s)>) | passthrough | 0 |
console: blam (begin <expression(s)>)
Called 10,520 times by the shipped campaign scripts, with 1 to 78 arguments.
begin_count
special formNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (begin_count <expression(s)>) | passthrough | 2 |
console: blam (begin_count <expression(s)>)
Called 1 time by the shipped campaign scripts, with 3 arguments.
begin_random
special formEvaluates the expressions in a random order.
| Signature | Returns | Slot |
|---|---|---|
| (begin_random <expression(s)>) | passthrough | 1 |
console: blam (begin_random <expression(s)>)
Called 65 times by the shipped campaign scripts, with 2 to 16 arguments.
begin_random_count
special formNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (begin_random_count <expression(s)>) | passthrough | 3 |
console: blam (begin_random_count <expression(s)>)
Called 40 times by the shipped campaign scripts, with 2 to 15 arguments.
bit_test
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bit_test <long> <short>) | long | 45 |
console: bit_test <long> <short>
bit_toggle
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bit_toggle <long> <short> <boolean>) | long | 46 |
console: bit_toggle <long> <short> <boolean>
bitwise_and
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_and <long> <long>) | long | 40 |
console: bitwise_and <long> <long>
bitwise_flags_toggle
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_flags_toggle <long> <long> <boolean>) | long | 47 |
console: bitwise_flags_toggle <long> <long> <boolean>
bitwise_left_shift
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_left_shift <long> <short>) | long | 43 |
console: bitwise_left_shift <long> <short>
bitwise_or
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_or <long> <long>) | long | 41 |
console: bitwise_or <long> <long>
bitwise_right_shift
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_right_shift <long> <short>) | long | 44 |
console: bitwise_right_shift <long> <short>
bitwise_xor
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (bitwise_xor <long> <long>) | long | 42 |
console: bitwise_xor <long> <long>
branch
special formNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (branch <condition> <script>) | void | 29 |
console: blam (branch <condition> <script>)
Called 150 times by the shipped campaign scripts, with 2 arguments.
breakpoint
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (breakpoint <string>) | void | 58 |
console: breakpoint <string>
cinematic_sleep
special formNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (cinematic_sleep <short> [<script>]) | void | 27 |
console: blam (cinematic_sleep <short> [<script>])
cond
special formEvaluates the first result whose condition is true.
| Signature | Returns | Slot |
|---|---|---|
| (cond (<boolean1> <result1>) [(<boolean2> <result2>) [...]]) | passthrough | 5 |
console: blam (cond (<boolean1> <result1>) [(<boolean2> <result2>) [...]])
device
special form→ deviceCasts an object to a device.
| Signature | Returns | Slot |
|---|---|---|
| (device <object>) | device | 33 |
console: blam (device <object>)
evaluate
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (evaluate <script>) | void | 35 |
console: evaluate <script>
get_executing_running_thread
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (get_executing_running_thread) | long | 60 |
console: get_executing_running_thread
if
special formEvaluates the second expression if the condition is true, otherwise the optional third.
| Signature | Returns | Slot |
|---|---|---|
| (if <boolean> <then> [<else>]) | passthrough | 4 |
console: blam (if <boolean> <then> [<else>])
Called 3,601 times by the shipped campaign scripts, with 2 to 3 arguments.
inspect
special formPrints an expression's value to the console.
| Signature | Returns | Slot |
|---|---|---|
| (inspect <expression>) | void | 28 |
console: blam (inspect <expression>)
Called 35 times by the shipped campaign scripts, with 1 argument.
kill_active_scripts
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (kill_active_scripts) | void | 59 |
console: kill_active_scripts
kill_thread
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (kill_thread <long>) | void | 61 |
console: kill_thread <long>
list_count
→ shortNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (list_count <object_list>) | short | 88 |
console: list_count <object_list>
Called 230 times by the shipped campaign scripts, with 1 argument.
list_count_not_dead
→ shortNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (list_count_not_dead <object_list>) | short | 89 |
console: list_count_not_dead <object_list>
Called 15 times by the shipped campaign scripts, with 1 argument.
list_get
→ objectNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (list_get <object_list> <short>) | object | 87 |
console: list_get <object_list> <short>
Called 341 times by the shipped campaign scripts, with 2 arguments.
log_print
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (log_print <string>) | void | 51 |
console: log_print <string>
max
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (max <number(s)>) | real | 15 |
console: blam (max <number(s)>)
Called 2 times by the shipped campaign scripts, with 2 arguments.
min
special form→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (min <number(s)>) | real | 14 |
console: blam (min <number(s)>)
Called 2 times by the shipped campaign scripts, with 2 arguments.
not
→ booleanLogical negation.
| Signature | Returns | Slot |
|---|---|---|
| (not <boolean>) | boolean | 36 |
console: not <boolean>
Called 824 times by the shipped campaign scripts, with 1 argument.
or
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (or <boolean(s)>) | boolean | 8 |
console: blam (or <boolean(s)>)
Called 819 times by the shipped campaign scripts, with 2 to 6 arguments.
pin
→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (pin <real> <real> <real>) | real | 37 |
console: pin <real> <real> <real>
Prints a string to the console.
| Signature | Returns | Slot |
|---|---|---|
| (print <string>) | void | 49 |
console: print <string>
Called 2,059 times by the shipped campaign scripts, with 1 argument.
print_if
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (print_if <boolean> <string>) | void | 50 |
console: print_if <boolean> <string>
Called 702 times by the shipped campaign scripts, with 2 arguments.
random_range
→ shortNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (random_range <short> <short>) | short | 188 |
console: random_range <short> <short>
Called 148 times by the shipped campaign scripts, with 2 arguments.
real_random_range
→ realNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (real_random_range <real> <real>) | real | 189 |
console: real_random_range <real> <real>
Called 96 times by the shipped campaign scripts, with 2 arguments.
scenery
special form→ sceneryCasts an object to scenery.
| Signature | Returns | Slot |
|---|---|---|
| (scenery <object>) | scenery | 34 |
console: blam (scenery <object>)
script_finished
→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (script_finished <string_id>) | boolean | 63 |
console: script_finished <string_id>
Called 84 times by the shipped campaign scripts, with 1 argument.
script_started
→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (script_started <string_id>) | boolean | 62 |
console: script_started <string_id>
Called 17 times by the shipped campaign scripts, with 1 argument.
set
special formAssigns a value to a global variable.
| Signature | Returns | Slot |
|---|---|---|
| (set <variable name> <expression>) | passthrough | 6 |
console: blam (set <variable name> <expression>)
Called 3,321 times by the shipped campaign scripts, with 2 arguments.
sleep
special formPauses the current script for the given number of simulation ticks.
| Signature | Returns | Slot |
|---|---|---|
| (sleep <short> [<script>]) | void | 22 |
console: blam (sleep <short> [<script>])
Called 2,506 times by the shipped campaign scripts, with 1 to 2 arguments.
sleep_forever
special formPauses the current script, or the named one, until something wakes it.
| Signature | Returns | Slot |
|---|---|---|
| (sleep_forever [<script>]) | void | 23 |
console: blam (sleep_forever [<script>])
Called 291 times by the shipped campaign scripts, with 0 to 1 arguments.
sleep_until
special form→ booleanPauses the current script until the condition is true, re-testing it every so many ticks.
| Signature | Returns | Slot |
|---|---|---|
| (sleep_until <boolean> [<short>]) | boolean | 24 |
console: blam (sleep_until <boolean> [<short>])
Called 5,044 times by the shipped campaign scripts, with 1 to 3 arguments.
sleep_until_game_ticks
special form→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sleep_until_game_ticks <boolean> [<short>]) | boolean | 25 |
console: blam (sleep_until_game_ticks <boolean> [<short>])
unit
special form→ unitCasts an object to a unit.
| Signature | Returns | Slot |
|---|---|---|
| (unit <object>) | unit | 30 |
console: blam (unit <object>)
Called 78 times by the shipped campaign scripts, with 1 argument.
vehicle
special form→ vehicleCasts an object to a vehicle.
| Signature | Returns | Slot |
|---|---|---|
| (vehicle <object>) | vehicle | 31 |
console: blam (vehicle <object>)
Called 1 time by the shipped campaign scripts, with 1 argument.
wake
special formWakes a sleeping script by name.
| Signature | Returns | Slot |
|---|---|---|
| (wake <script name>) | void | 26 |
console: blam (wake <script name>)
Called 2,482 times by the shipped campaign scripts, with 1 argument.
weapon
special form→ weaponCasts an object to a weapon.
| Signature | Returns | Slot |
|---|---|---|
| (weapon <object>) | weapon | 32 |
console: blam (weapon <object>)
Read from the function table in the shipped simulation DLL. A name is compiled out when every one of its slots points at the release build's shared stub evaluator; the console still accepts it and returns nothing. Descriptions are hand-written and incomplete; the engine's own help text does not survive in this build. See The Blam console for how the table was found and how the mod runs these.