PlatinumSDK Lua API
Open searchable reader
engine.ui_open
engine.ui_open(path, modal)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| modal | Option<bool> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:5
engine.ui_close
engine.ui_close()
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:6
engine.ui_set_value
engine.ui_set_value(name, value)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
| value | Value | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:7
engine.spawn_asset
engine.spawn_asset(path, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Spawn |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:8
engine.load_level
engine.load_level(level, preserve)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| level | String | False |
| preserve | Option<bool> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::LoadLevel |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:9
engine.set_game_phase
engine.set_game_phase(phase)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| phase | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Phase |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:10
engine.move_player
engine.move_player(id, x, z, sprint)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| x | f32 | False |
| z | f32 | False |
| sprint | bool | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Move |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:11
engine.jump
engine.jump(id)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Jump |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:12
engine.try_pickup
engine.try_pickup(id, radius)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| radius | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Pickup |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:13
engine.fire
engine.fire(id)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Fire |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:14
engine.add_score
engine.add_score(points)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| points | i32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Score |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:15
engine.destroy
engine.destroy(id)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Destroy |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:16
engine.notify
engine.notify(message)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| message | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Notify |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:17
engine.rotate_beacon
engine.rotate_beacon(id, angle)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| angle | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Spin |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:18
engine.apply_impulse
engine.apply_impulse(id, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Physics |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:19
engine.set_velocity
engine.set_velocity(id, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Physics |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:20
engine.set_angular_velocity
engine.set_angular_velocity(id, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Physics |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:21
engine.teleport_body
engine.teleport_body(id, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Physics |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:22
engine.emit_particles
engine.emit_particles(path, x, y, z, scale)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
| scale | Option<f32> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Particles |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:23
engine.explode
engine.explode(id, radius, damage, impulse)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| radius | f32 | False |
| damage | f32 | False |
| impulse | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Explosion |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:24
engine.switch_weapon
engine.switch_weapon(slot)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| slot | usize | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Switch |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:25
engine.give_equipment
engine.give_equipment(player, item)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| item | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:26
engine.equip_slot
engine.equip_slot(player, slot)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| slot | usize | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:27
engine.drop_equipment
engine.drop_equipment(player, item)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| item | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:28
engine.use_equipment
engine.use_equipment(player)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:29
engine.reload_equipment
engine.reload_equipment(player)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:30
engine.set_equipment_animation_playback
engine.set_equipment_animation_playback(player, options)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| options | Option<Table> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Equipment |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:31
engine.set_match_mode
engine.set_match_mode(name)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::GameMode |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:38
engine.set_scene_residency
engine.set_scene_residency(reference, value)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| reference | String | False |
| value | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:39
engine.set_scene_event_scope
engine.set_scene_event_scope(reference, kind, include, exclude)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| reference | String | False |
| kind | String | False |
| include | Option<String> | True |
| exclude | Option<String> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:40
engine.assign_object_scene
engine.assign_object_scene(id, reference)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| reference | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:41
engine.spawn_in_scene
engine.spawn_in_scene(source, reference, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| source | String | False |
| reference | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:42
engine.mount_scene
engine.mount_scene(source, reference, residency, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| source | String | False |
| reference | String | False |
| residency | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:43
engine.set_scene_asset_defaults
engine.set_scene_asset_defaults(source, residency, scope)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| source | String | False |
| residency | String | False |
| scope | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:44
engine.set_scene_child_defaults
engine.set_scene_child_defaults(reference, residency, scope)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| reference | String | False |
| residency | Option<String> | True |
| scope | Option<String> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:45
engine.scene_command
engine.scene_command(text)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| text | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Scene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:46
engine.stream_scene_in
engine.stream_scene_in(path, x, y, z)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::StreamIn |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:47
engine.stream_scene_out
engine.stream_scene_out(root)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| root | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::StreamOut |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:48
engine.heal_player
engine.heal_player(player, amount)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| amount | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::HealPlayer |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:49
engine.damage_player
engine.damage_player(player, amount)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| player | ExactLuaEntity | False |
| amount | f32 | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::DamagePlayer |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:50
engine.anim_set_parameter
engine.anim_set_parameter(id, name, value)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| name | String | False |
| value | Value | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:51
engine.anim_trigger
engine.anim_trigger(id, name)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| name | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:52
engine.ik_set_target
engine.ik_set_target(id, root, middle, end, x, y, z, px, py, pz, weight)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| root | String | False |
| middle | String | False |
| end | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
| px | f32 | False |
| py | f32 | False |
| pz | f32 | False |
| weight | Option<f32> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:53
engine.look_at
engine.look_at(id, bone, x, y, z, weight)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| bone | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
| weight | Option<f32> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:54
engine.spine_aim
engine.spine_aim(id, bones, pitch, yaw, weight)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
| bones | Table | False |
| pitch | f32 | False |
| yaw | f32 | False |
| weight | Option<f32> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:55
engine.ik_clear
engine.ik_clear(id)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Character |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:56
engine.play_sound
engine.play_sound(path, x, y, z, gain)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| x | f32 | False |
| y | f32 | False |
| z | f32 | False |
| gain | Option<f32> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Sound |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:57
engine.emit
engine.emit(name, source, values)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
| source | ExactLuaEntity | False |
| values | Option<Table> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Emit |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:58
engine.play_animation
engine.play_animation(path, bindings, values, options)
Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| bindings | Table | False |
| values | Option<Table> | True |
| options | Option<Table> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::AnimateWithOptions |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:59
engine.scene_entities
engine.scene_entities(reference)
Return the exact entity identities in a scene reference.
Parameters (registration types)| Name | Type | Optional |
|---|
| reference | String | False |
Return descriptor:
vec![LuaType::Array(Box::new(LuaType::Named("EntityId".into())))]Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::SceneEntities |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:105
engine.object_scene
engine.object_scene(id)
Return the object's scene reference, or nil if it is unavailable.
Parameters (registration types)| Name | Type | Optional |
|---|
| id | ExactLuaEntity | False |
Return descriptor:
vec![LuaType::Optional(Box::new(LuaType::String))]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::ObjectScene |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:110
engine.scene_residency
engine.scene_residency(reference)
Return scene residency, or nil if the reference is unavailable.
Parameters (registration types)| Name | Type | Optional |
|---|
| reference | String | False |
Return descriptor:
vec![LuaType::Optional(Box::new(LuaType::String))]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::SceneResidency |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:115
engine.ui_get
engine.ui_get(document, id, property)
Read one validated scalar UI widget property in the executing player's UI state.
Parameters (registration types)| Name | Type | Optional |
|---|
| document | String | False |
| id | ExactLuaEntity | False |
| property | String | False |
Return descriptor:
vec![LuaType::Union(vec![
LuaType::String,
LuaType::Number,
LuaType::Boolean,
])]Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::UiGet |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:120
engine.ui_patch
engine.ui_patch(document, id, properties)
Validate and apply scalar widget property changes; the engine queues the authoritative UI command.
Parameters (registration types)| Name | Type | Optional |
|---|
| document | String | False |
| id | ExactLuaEntity | False |
| properties | Table | False |
Return descriptor:
vec![]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::UiPatch |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:129
engine.set_game_value
engine.set_game_value(name, value)
Set a bounded named boolean, finite number or string game value.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
| value | Value | False |
Return descriptor:
vec![]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::SetGameValue |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:134
engine.get_game_value
engine.get_game_value(name)
Read a named game value; absent values return nil.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
Return descriptor:
vec![LuaType::Unknown]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::GetGameValue |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:135
engine.ui.open
engine.ui.open(path, modal)
Alias of engine.ui_open. Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| path | String | False |
| modal | Option<bool> | True |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:5
engine.ui.get
engine.ui.get(document, id, property)
Alias of engine.ui_get. Read one validated scalar UI widget property in the executing player's UI state.
Parameters (registration types)| Name | Type | Optional |
|---|
| document | String | False |
| id | ExactLuaEntity | False |
| property | String | False |
Return descriptor:
vec![LuaType::Union(vec![
LuaType::String,
LuaType::Number,
LuaType::Boolean,
])]Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::UiGet |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:120
engine.ui.patch
engine.ui.patch(document, id, properties)
Alias of engine.ui_patch. Validate and apply scalar widget property changes; the engine queues the authoritative UI command.
Parameters (registration types)| Name | Type | Optional |
|---|
| document | String | False |
| id | ExactLuaEntity | False |
| properties | Table | False |
Return descriptor:
vec![]
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | QueryBinding::UiPatch |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:129
engine.ui.set_value
engine.ui.set_value(name, value)
Alias of engine.ui_set_value. Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Parameters (registration types)| Name | Type | Optional |
|---|
| name | String | False |
| value | Value | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:7
engine.ui.close
engine.ui.close()
Alias of engine.ui_close. Registered engine command; execution uses the actor/player's validated authority context. Arguments below are Rust registration types; Option<T> is optional. Command dispatch does not imply completion or a returned value.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | LuaCommand::Ui |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:6
userdata<Proxy> metamethod Index
userdata<Proxy> [MetaMethod::Index](key)
Registered mlua meta_method on platinum_lua::Proxy. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Parameters (registration types)| Name | Type | Optional |
|---|
| key | Value | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for Proxy / add_meta_method(MetaMethod::Index, closure) |
Source: crates/platinum-lua/src/lib.rs:259
userdata<Proxy> metamethod NewIndex
userdata<Proxy> [MetaMethod::NewIndex](key, value)
Registered mlua meta_method on platinum_lua::Proxy. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Parameters (registration types)| Name | Type | Optional |
|---|
| key | Value | False |
| value | Value | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for Proxy / add_meta_method(MetaMethod::NewIndex, closure) |
Source: crates/platinum-lua/src/lib.rs:262
userdata<Proxy> metamethod ToString
userdata<Proxy> [MetaMethod::ToString]()
Registered mlua meta_method on platinum_lua::Proxy. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for Proxy / add_meta_method(MetaMethod::ToString, closure) |
Source: crates/platinum-lua/src/lib.rs:266
userdata<Proxy> metamethod Len
userdata<Proxy> [MetaMethod::Len]()
Registered mlua meta_method on platinum_lua::Proxy. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for Proxy / add_meta_method(MetaMethod::Len, closure) |
Source: crates/platinum-lua/src/lib.rs:267
userdata<Proxy> metamethod Pairs
userdata<Proxy> [MetaMethod::Pairs]()
Registered mlua meta_method on platinum_lua::Proxy. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for Proxy / add_meta_method(MetaMethod::Pairs, closure) |
Source: crates/platinum-lua/src/lib.rs:277
userdata<LuaLiveView>:snapshot
userdata<LuaLiveView>:snapshot()
Registered mlua method on platinum_lua::live_view::LuaLiveView. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Use receiver:snapshot(...) on that supplied value. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for LuaLiveView / add_method("snapshot", closure) |
Source: crates/platinum-lua/src/live_view.rs:46
userdata<LuaLiveView>:commit
userdata<LuaLiveView>:commit(base, table)
Registered mlua method on platinum_lua::live_view::LuaLiveView. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Use receiver:commit(...) on that supplied value. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Parameters (registration types)| Name | Type | Optional |
|---|
| base | mlua::String | False |
| table | Table | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for LuaLiveView / add_method("commit", closure) |
Source: crates/platinum-lua/src/live_view.rs:80
userdata<LuaLiveView>:copy_transient
userdata<LuaLiveView>:copy_transient()
Registered mlua method on platinum_lua::live_view::LuaLiveView. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Use receiver:copy_transient(...) on that supplied value. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply.
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for LuaLiveView / add_method("copy_transient", closure) |
Source: crates/platinum-lua/src/live_view.rs:90
userdata<LuaLiveView>:copy_to
userdata<LuaLiveView>:copy_to(destination, name)
Registered mlua method on platinum_lua::live_view::LuaLiveView. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Use receiver:copy_to(...) on that supplied value. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply. Source registration attributes: #[cfg(not(target_arch = "wasm32"))]
Parameters (registration types)| Name | Type | Optional |
|---|
| destination | AnyUserData | False |
| name | String | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for LuaLiveView / add_method("copy_to", closure) |
Source: crates/platinum-lua/src/live_view.rs:106
userdata<LuaLiveView>:copy_adjacent
userdata<LuaLiveView>:copy_adjacent(location)
Registered mlua method on platinum_lua::live_view::LuaLiveView. The userdata receiver label is descriptive, not a Lua global or constructor. A trusted host supplies the actual receiver/capability and chooses its Lua variable name. Use receiver:copy_adjacent(...) on that supplied value. Parameter types are copied from the registration closure; omitted types are reported as unknown. Return types inferred by Rust are not guessed. Feature/platform gates and host authorization still apply. Source registration attributes: #[cfg(not(target_arch = "wasm32"))]
Parameters (registration types)| Name | Type | Optional |
|---|
| location | AnyUserData | False |
Source-evidenced cross-language references| Lua | Event Table | Native |
|---|
| | impl UserData for LuaLiveView / add_method("copy_adjacent", closure) |
Source: crates/platinum-lua/src/live_view.rs:118