Volumes
Trigger volumes: testing objects and players against them, and teleporting the ones outside.
- Functions
- 9
- Work in this build
- 9
- Compiled out
- 0
volume_return_objects
→ object_listNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (volume_return_objects <trigger_volume>) | object_list | 83 |
console: volume_return_objects <trigger_volume>
Called 1 time by the shipped campaign scripts, with 1 argument.
volume_return_objects_by_campaign_type
→ object_listNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (volume_return_objects_by_campaign_type <trigger_volume> <long>) | object_list | 85 |
console: volume_return_objects_by_campaign_type <trigger_volume> <long>
volume_return_objects_by_type
→ object_listNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (volume_return_objects_by_type <trigger_volume> <long>) | object_list | 84 |
console: volume_return_objects_by_type <trigger_volume> <long>
Called 9 times by the shipped campaign scripts, with 2 arguments.
volume_teleport_players_not_inside
Teleports any player outside the trigger volume to the flag.
| Signature | Returns | Slot |
|---|---|---|
| (volume_teleport_players_not_inside <trigger_volume> <cutscene_flag>) | void | 77 |
console: volume_teleport_players_not_inside <trigger_volume> <cutscene_flag>
Called 57 times by the shipped campaign scripts, with 2 arguments.
volume_test_object
→ booleanWhether an object is inside a trigger volume.
| Signature | Returns | Slot |
|---|---|---|
| (volume_test_object <trigger_volume> <object>) | boolean | 78 |
console: volume_test_object <trigger_volume> <object>
Called 295 times by the shipped campaign scripts, with 2 arguments.
volume_test_objects
→ booleanWhether any object in the list is inside a trigger volume.
| Signature | Returns | Slot |
|---|---|---|
| (volume_test_objects <trigger_volume> <object_list>) | boolean | 79 |
console: volume_test_objects <trigger_volume> <object_list>
Called 115 times by the shipped campaign scripts, with 2 arguments.
volume_test_objects_all
→ booleanWhether every object in the list is inside a trigger volume.
| Signature | Returns | Slot |
|---|---|---|
| (volume_test_objects_all <trigger_volume> <object_list>) | boolean | 80 |
console: volume_test_objects_all <trigger_volume> <object_list>
Called 9 times by the shipped campaign scripts, with 2 arguments.
volume_test_players
→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (volume_test_players <trigger_volume>) | boolean | 81 |
console: volume_test_players <trigger_volume>
Called 2,704 times by the shipped campaign scripts, with 1 argument.
volume_test_players_all
→ booleanNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (volume_test_players_all <trigger_volume>) | boolean | 82 |
console: volume_test_players_all <trigger_volume>
Called 55 times by the shipped campaign scripts, with 1 argument.
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.