platinum_sdk public native declarations
Open searchable reader
platinum_sdk::AppDescriptor
pub struct AppDescriptor
Identity and initial host-window dimensions for a standalone SDK application.
Public data fields| Name | Type / declaration | Description |
|---|
| id | &'static str | |
| title | &'static str | |
| width | u32 | |
| height | u32 | |
| close_when_requested | bool | Set false when the app handles WindowCloseRequested itself. |
Source: crates/platinum-sdk/src/lib.rs:39
platinum_sdk::AppDescriptor::new
pub fn new(id: &'static str, title: &'static str) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lib.rs:49
platinum_sdk::application
pub fn application(descriptor: AppDescriptor) -> App
Creates a native window on Windows or targets #platinum-canvas on the web.
Source: crates/platinum-sdk/src/lib.rs:61
platinum_sdk::command
platinum_sdk::command
Typed application commands shared by menus, buttons and shortcuts.
Source: crates/platinum-sdk/src/command.rs:1
platinum_sdk::command::CommandId
pub struct CommandId(pub &'static str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:5
platinum_sdk::command::CommandInvoked
pub struct CommandInvoked(pub CommandId)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:8
platinum_sdk::command::CommandButton
pub struct CommandButton(pub CommandId)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:11
platinum_sdk::command::Shortcut
pub struct Shortcut
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| command | CommandId | |
| key | KeyCode | |
| shift | bool | |
Source: crates/platinum-sdk/src/command.rs:14
platinum_sdk::command::Shortcut::ctrl
pub fn ctrl(command: CommandId, key: KeyCode) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:20
platinum_sdk::command::Shortcut::ctrl_shift
pub fn ctrl_shift(command: CommandId, key: KeyCode) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:27
platinum_sdk::command::Shortcuts
pub struct Shortcuts(pub Vec<Shortcut>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:36
platinum_sdk::command::CommandPlugin
pub struct CommandPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/command.rs:38
platinum_sdk::content_provider
platinum_sdk::content_provider
Closed read-only content views for already admitted storage providers.
No OS grants, tenant authentication, filesystem scanning or file mutation.
The mount bridge is trusted-backend compatibility routing, never authorization
from a caller-provided path. Do not expose its global lookup to untrusted UI.
Source: crates/platinum-sdk/src/content_provider.rs:1
platinum_sdk::content_provider::ContentError
pub enum ContentError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:17
platinum_sdk::content_provider::ContentResult
pub type ContentResult<T>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:31
platinum_sdk::content_provider::ContentFile
pub struct ContentFile
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| asset_id | Option<AssetId> | A real supplied asset identity, not a fabricated GUID from its path/hash. |
| bytes | u64 | |
| sha256 | Option<String> | |
Source: crates/platinum-sdk/src/content_provider.rs:33
platinum_sdk::content_provider::ContentIndex
pub struct ContentIndex
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:40
platinum_sdk::content_provider::ContentIndex::new
pub fn new(
files: Vec<ContentFile>,
maximum_files: usize,
maximum_bytes: u64,
) -> ContentResult<Self>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:46
platinum_sdk::content_provider::ContentIndex::file
pub fn file(&self, path: &str) -> Option<&ContentFile>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:87
platinum_sdk::content_provider::ContentIndex::by_id
pub fn by_id(&self, id: AssetId) -> Option<&ContentFile>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:90
platinum_sdk::content_provider::ContentIndex::files
pub fn files(&self) -> impl Iterator<Item
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:93
platinum_sdk::content_provider::ReadOnlyContentProvider
pub trait ReadOnlyContentProvider: Send + Sync + 'static
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:97
platinum_sdk::content_provider::ContentView
pub struct ContentView(Arc<dyn ReadOnlyContentProvider>, u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:105
platinum_sdk::content_provider::ContentView::admitted
pub fn admitted(provider: Arc<dyn ReadOnlyContentProvider>) -> Self
Only a trusted host passes an already admitted provider here. This does
not convert an app name/path/asset ID into a storage permission.
Source: crates/platinum-sdk/src/content_provider.rs:109
platinum_sdk::content_provider::ContentView::identity
pub fn identity(&self) -> u64
Process-local immutable view revision for cache isolation, not a grant.
Source: crates/platinum-sdk/src/content_provider.rs:114
platinum_sdk::content_provider::ContentView::index
pub fn index(&self) -> &ContentIndex
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:117
platinum_sdk::content_provider::ContentView::read_range
pub fn read_range(
&self,
path: &str,
offset: u64,
bytes: u64,
maximum: u64,
) -> ContentResult<Vec<u8>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:120
platinum_sdk::content_provider::ContentView::read
pub fn read(&self, path: &str, maximum: u64) -> ContentResult<Vec<u8>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:139
platinum_sdk::content_provider::ContentView::text
pub fn text(&self, path: &str, maximum: u64) -> ContentResult<String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:143
platinum_sdk::content_provider::MountedContent
pub struct MountedContent(Arc<Mount>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:173
platinum_sdk::content_provider::MountedContent::new
pub fn new(view: ContentView) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:175
platinum_sdk::content_provider::MountedContent::root
pub fn root(&self) -> &Path
Process-local routing token, never a durable document ID or IPC identity.
Source: crates/platinum-sdk/src/content_provider.rs:193
platinum_sdk::content_provider::MountedContent::view
pub fn view(&self) -> &ContentView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:196
platinum_sdk::content_provider::mounted_root
pub fn mounted_root(root: &Path) -> ContentResult<Option<ContentView>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:205
platinum_sdk::content_provider::mounted_path
pub fn mounted_path(path: &Path) -> ContentResult<Option<(ContentView, String)>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider.rs:218
platinum_sdk::content_provider::snapshot
platinum_sdk::content_provider::snapshot
Bounded immutable captured-byte views for already-authorized host producers.
File metadata is an observation hint, not an atomic OS snapshot guarantee.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:1
platinum_sdk::content_provider::snapshot::SnapshotBudget
pub struct SnapshotBudget(Arc<Budget>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:7
platinum_sdk::content_provider::snapshot::SnapshotReservation
pub struct SnapshotReservation
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:12
platinum_sdk::content_provider::snapshot::SnapshotBudget::new
pub fn new(maximum: usize) -> ContentResult<Self>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:17
platinum_sdk::content_provider::snapshot::SnapshotBudget::reserve
pub fn reserve(&self, bytes: usize) -> ContentResult<SnapshotReservation>
Reserve before allocating/reading encoded content. Producers must keep
transient buffers within this reservation as well as their own quotas.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:28
platinum_sdk::content_provider::snapshot::SnapshotBudget::used_bytes
pub fn used_bytes(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:41
platinum_sdk::content_provider::snapshot::SnapshotFile
pub struct SnapshotFile
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| asset_id | Option<AssetId> | Only an actual host-supplied registered AssetId; otherwise use None/path. |
| bytes | Arc<[u8]> | |
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:53
platinum_sdk::content_provider::snapshot::immutable_snapshot
pub fn immutable_snapshot(
files: Vec<SnapshotFile>,
maximum_files: usize,
reservation: SnapshotReservation,
) -> ContentResult<ContentView>
Every index length derives from retained immutable bytes. No digest/GUID is
invented; a new view identity is the revision when no actual digest exists.
Source: crates/platinum-sdk/src/content_provider/snapshot.rs:66
platinum_sdk::contained_layout
platinum_sdk::contained_layout
Preserve contained-window placement across transient minimized viewports.
egui constrains an Area when it is shown. Showing all child windows against
a minimized 0/1-pixel host rewrites their saved positions to the same corner.
Source: crates/platinum-sdk/src/contained_layout.rs:1
platinum_sdk::contained_layout::is_usable
pub fn is_usable(ctx: &egui::Context) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/contained_layout.rs:6
platinum_sdk::input
platinum_sdk::input
Shared focus-boundary cleanup for native and browser SDK applications.
Source: crates/platinum-sdk/src/input.rs:1
platinum_sdk::input::InputReset
pub struct InputReset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| requested | bool | Request cleanup at the next input boundary (for example when pausing). |
| reset_this_frame | bool | Consumers can release gameplay capture even if focus returned this frame. |
Source: crates/platinum-sdk/src/input.rs:14
platinum_sdk::input::FocusInputPlugin
pub struct FocusInputPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/input.rs:21
platinum_sdk::platform
platinum_sdk::platform
Host file dialogs, browser import/download and local draft persistence.
These adapters have host privileges. They are not an OS sandbox.
Source: crates/platinum-sdk/src/platform.rs:1
platinum_sdk::platform::MAX_FILE_BYTES
pub const MAX_FILE_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:8
platinum_sdk::platform::FileResult
pub enum FileResult
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:11
platinum_sdk::platform::FileService
pub struct FileService
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:39
platinum_sdk::platform::FileService::save_to_path
pub fn save_to_path(&self, path: std::path::PathBuf, bytes: Vec<u8>, snapshot: String)
Save an already-open native document back to its actual filesystem location.
Source: crates/platinum-sdk/src/platform.rs:48
platinum_sdk::platform::FileService::store_recovery
pub fn store_recovery(&self, key: &str, content: String)
Native disk writes run in one worker; final close uses an acknowledged write in that queue.
Source: crates/platinum-sdk/src/platform.rs:106
platinum_sdk::platform::FileService::flush_recovery
pub fn flush_recovery(&self, key: &str, content: String) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:123
platinum_sdk::platform::FileService::drain
pub fn drain(&self) -> Vec<FileResult>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:142
platinum_sdk::platform::FileService::open
pub fn open(&self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:145
platinum_sdk::platform::FileService::image
pub fn image(&self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:148
platinum_sdk::platform::FileService::save
pub fn save(&self, name: &str, snapshot: String, document: bool)
Save a document or export text. A browser download counts as export, not durable draft storage.
Source: crates/platinum-sdk/src/platform.rs:217
platinum_sdk::platform::FileService::save_bytes
pub fn save_bytes(&self, name: &str, bytes: Vec<u8>, snapshot: String, document: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:220
platinum_sdk::platform::load_draft
pub fn load_draft(key: &str) -> Result<Option<String>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:327
platinum_sdk::platform::store_draft
pub fn store_draft(key: &str, content: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:348
platinum_sdk::platform::set_document_dirty
pub fn set_document_dirty(_dirty: bool)
Warns before navigating away from a browser document with unsaved edits.
Source: crates/platinum-sdk/src/platform.rs:372
platinum_sdk::platform::set_document_dirty
pub fn set_document_dirty(dirty: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/platform.rs:375
platinum_sdk::ui
platinum_sdk::ui
Reusable Platinum chrome and controls. All controls render through Bevy UI.
Source: crates/platinum-sdk/src/ui.rs:1
platinum_sdk::ui::PlatinumTheme
pub struct PlatinumTheme
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:17
platinum_sdk::ui::PlatinumTheme::DESKTOP
pub const DESKTOP: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:19
platinum_sdk::ui::PlatinumTheme::FACE
pub const FACE: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:20
platinum_sdk::ui::PlatinumTheme::LIGHT
pub const LIGHT: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:21
platinum_sdk::ui::PlatinumTheme::SHADOW
pub const SHADOW: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:22
platinum_sdk::ui::PlatinumTheme::INK
pub const INK: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:23
platinum_sdk::ui::PlatinumTheme::BLUE
pub const BLUE: Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:24
platinum_sdk::ui::PlatinumFonts
pub struct PlatinumFonts
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| ui | Handle<Font> | |
| serif | Handle<Font> | |
| serif_italic | Handle<Font> | |
Source: crates/platinum-sdk/src/ui.rs:27
platinum_sdk::ui::FontLoading
pub struct FontLoading
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:33
platinum_sdk::ui::UiPlugin
pub struct UiPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:35
platinum_sdk::ui::raised
pub fn raised() -> BorderColor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:51
platinum_sdk::ui::sunken
pub fn sunken() -> BorderColor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:59
platinum_sdk::ui::font
pub fn font(fonts: &PlatinumFonts, size: f32) -> TextFont
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:67
platinum_sdk::ui::label
pub fn label(
commands: &mut Commands,
parent: Entity,
value: impl Into<String>,
fonts: &PlatinumFonts,
size: f32,
) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:74
platinum_sdk::ui::row
pub fn row(commands: &mut Commands, parent: Entity, gap: f32) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:91
platinum_sdk::ui::ButtonSelected
pub struct ButtonSelected(pub bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:105
platinum_sdk::ui::button
pub fn button(
commands: &mut Commands,
parent: Entity,
text: &str,
command: CommandId,
fonts: &PlatinumFonts,
) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:133
platinum_sdk::ui::MenuItem
pub struct MenuItem
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| label | &'static str | |
| command | CommandId | |
Source: crates/platinum-sdk/src/ui.rs:164
platinum_sdk::ui::menu_bar
pub fn menu_bar(
commands: &mut Commands,
parent: Entity,
app_name: &str,
menus: &[(&str, &[MenuItem])],
fonts: &PlatinumFonts,
) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:172
platinum_sdk::ui::WindowParts
pub struct WindowParts
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| frame | Entity | |
| title | Entity | |
| body | Entity | |
| status | Entity | |
Source: crates/platinum-sdk/src/ui.rs:308
platinum_sdk::ui::window
pub fn window(
commands: &mut Commands,
parent: Entity,
title: &str,
close_command: CommandId,
fonts: &PlatinumFonts,
) -> WindowParts
Creates a responsive app frame. The actual OS window owns movement and resizing.
Source: crates/platinum-sdk/src/ui.rs:315
platinum_sdk::ui::WindowTitle
pub struct WindowTitle
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/ui.rs:418
platinum_sdk::ui::text_editor
pub fn text_editor(
commands: &mut Commands,
parent: Entity,
value: &str,
fonts: &PlatinumFonts,
) -> Entity
Multiline text entry with Unicode selection, caret, IME and clipboard via Bevy.
Source: crates/platinum-sdk/src/ui.rs:420
platinum_sdk::state_sync
platinum_sdk::state_sync
SDK facade for renderer-free tracked state scheduling and local data providers.
Source: crates/platinum-sdk/src/state_sync.rs:1
platinum_sdk::live_lua
platinum_sdk::live_lua
Native managed Lua model bindings, usable without the renderer through platinum-lua.
Source: crates/platinum-sdk/src/live_lua.rs:1
platinum_sdk::authoring
platinum_sdk::authoring
Domain-neutral authoring controls. Documents retain authority, storage and undo.
Controls emit commands rather than mutating the supplied document. IDs are exact
integers scoped by the caller's widget salt; they are not capabilities. Hosts
must validate commands against their latest revision before applying them.
These initial controls do not yet provide a complete accessibility contract,
hierarchy virtualization, drag/drop or collaborative undo.
Source: crates/platinum-sdk/src/authoring.rs:1
platinum_sdk::authoring::Gesture
pub struct Gesture<T>
A preview gesture becomes one undoable operation only on commit. Cancellation
returns its original value, allowing a host that applied previews to restore it.
Source: crates/platinum-sdk/src/authoring.rs:17
platinum_sdk::authoring::Gesture::begin
pub fn begin(value: T) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring.rs:23
platinum_sdk::authoring::Gesture::preview
pub fn preview(&mut self, value: T)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring.rs:29
platinum_sdk::authoring::Gesture::current
pub fn current(&self) -> &T
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring.rs:32
platinum_sdk::authoring::Gesture::cancel
pub fn cancel(self) -> T
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring.rs:35
platinum_sdk::authoring::Gesture::commit
pub fn commit(self) -> Option<(T, T)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring.rs:38
platinum_sdk::authoring::hierarchy
platinum_sdk::authoring::hierarchy
A model-backed tree with exact IDs and validated reparent commands.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:1
platinum_sdk::authoring::hierarchy::ItemId
pub type ItemId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:5
platinum_sdk::authoring::hierarchy::Item
pub struct Item
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | ItemId | |
| parent | Option<ItemId> | |
| label | String | |
| can_reparent | bool | |
| accepts_children | bool | |
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:8
platinum_sdk::authoring::hierarchy::HierarchyError
pub enum HierarchyError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:17
platinum_sdk::authoring::hierarchy::Hierarchy
pub struct Hierarchy<'a>
Validated immutable tree. Input order determines sibling order.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:27
platinum_sdk::authoring::hierarchy::Hierarchy::new
pub fn new(items: &'a [Item]) -> Result<Self, HierarchyError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:34
platinum_sdk::authoring::hierarchy::Hierarchy::reparent
pub fn reparent(
&self,
item: ItemId,
parent: Option<ItemId>,
allow_cross_root: bool,
) -> Result<Reparent, HierarchyError>
Only validates topology. Domain-specific placement preservation (world
transforms, list ordering, etc.) must be performed atomically by the host.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:76
platinum_sdk::authoring::hierarchy::Reparent
pub struct Reparent
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| item | ItemId | |
| previous_parent | Option<ItemId> | |
| parent | Option<ItemId> | |
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:111
platinum_sdk::authoring::hierarchy::HierarchyView
pub struct HierarchyView
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| selected | BTreeSet<ItemId> | |
| collapsed | BTreeSet<ItemId> | |
| filter | String | |
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:118
platinum_sdk::authoring::hierarchy::HierarchyView::show
pub fn show(&mut self, ui: &mut Ui, salt: impl std::hash::Hash, model: &Hierarchy<'_>) -> bool
Ctrl/Command-click toggles selection. Buttons provide keyboard-operable
expansion; full tree keyboard navigation and drag/drop are pending.
Source: crates/platinum-sdk/src/authoring/hierarchy.rs:127
platinum_sdk::authoring::history
platinum_sdk::authoring::history
Bounded snapshot history for local documents. Collaborative documents need an
operation-aware undo policy; this type deliberately rejects stale snapshots.
Source: crates/platinum-sdk/src/authoring/history.rs:1
platinum_sdk::authoring::history::HistoryError
pub enum HistoryError<E>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:6
platinum_sdk::authoring::history::History
pub struct History<T>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:11
platinum_sdk::authoring::history::History::new
pub fn new(capacity: usize) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:18
platinum_sdk::authoring::history::History::can_undo
pub fn can_undo(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:25
platinum_sdk::authoring::history::History::can_redo
pub fn can_redo(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:28
platinum_sdk::authoring::history::History::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:31
platinum_sdk::authoring::history::History::record
pub fn record<E>(
&mut self,
before: T,
after: T,
validate: impl Fn(&T) -> Result<(), E>,
) -> Result<bool, HistoryError<E>>
Record one completed gesture. Preview and cancelled values must not be
recorded. Capacity bounds entries, not bytes; bound document sizes too.
Source: crates/platinum-sdk/src/authoring/history.rs:37
platinum_sdk::authoring::history::History::undo
pub fn undo<E>(
&mut self,
current: &T,
validate: impl Fn(&T) -> Result<(), E>,
) -> Result<Option<T>, HistoryError<E>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:57
platinum_sdk::authoring::history::History::redo
pub fn redo<E>(
&mut self,
current: &T,
validate: impl Fn(&T) -> Result<(), E>,
) -> Result<Option<T>, HistoryError<E>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/history.rs:73
platinum_sdk::authoring::inspector
platinum_sdk::authoring::inspector
Typed inspector schemas and validated, reversible property edit commands.
Source: crates/platinum-sdk/src/authoring/inspector.rs:1
platinum_sdk::authoring::inspector::PropertyId
pub type PropertyId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:6
platinum_sdk::authoring::inspector::Value
pub enum Value
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:9
platinum_sdk::authoring::inspector::PropertyKind
pub enum PropertyKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:17
platinum_sdk::authoring::inspector::PropertySchema
pub struct PropertySchema
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | PropertyId | |
| label | String | |
| kind | PropertyKind | |
| default | Value | |
| read_only | bool | A presentation restriction, not an authorization boundary. |
Source: crates/platinum-sdk/src/authoring/inspector.rs:25
platinum_sdk::authoring::inspector::PropertySchema::accepts
pub fn accepts(&self, value: &Value) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:35
platinum_sdk::authoring::inspector::SchemaRegistry
pub struct SchemaRegistry
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:54
platinum_sdk::authoring::inspector::SchemaError
pub enum SchemaError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:59
platinum_sdk::authoring::inspector::SchemaRegistry::register
pub fn register(&mut self, schema: PropertySchema) -> Result<(), SchemaError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:65
platinum_sdk::authoring::inspector::SchemaRegistry::get
pub fn get(&self, id: PropertyId) -> Option<&PropertySchema>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:75
platinum_sdk::authoring::inspector::SchemaRegistry::iter
pub fn iter(&self) -> impl Iterator<Item
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:78
platinum_sdk::authoring::inspector::PropertyValues
pub type PropertyValues
None represents a mixed multiselection. Hosts should snapshot every selected
target before applying previews; None alone cannot restore their distinct values.
Source: crates/platinum-sdk/src/authoring/inspector.rs:85
platinum_sdk::authoring::inspector::PropertyEdit
pub enum PropertyEdit
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:88
platinum_sdk::authoring::inspector::Inspector
pub struct Inspector
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:108
platinum_sdk::authoring::inspector::Inspector::is_editing
pub fn is_editing(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:113
platinum_sdk::authoring::inspector::Inspector::cancel
pub fn cancel(&mut self) -> Vec<PropertyEdit>
Call when changing the inspected selection or disposing the control. Hosts
must restore their per-target snapshot for each returned cancellation.
Source: crates/platinum-sdk/src/authoring/inspector.rs:118
platinum_sdk::authoring::inspector::Inspector::show
pub fn show(
&mut self,
ui: &mut Ui,
salt: impl std::hash::Hash,
registry: &SchemaRegistry,
values: &PropertyValues,
) -> Vec<PropertyEdit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/inspector.rs:127
platinum_sdk::authoring::timeline
platinum_sdk::authoring::timeline
Integer-time timeline. Rendering coordinates never become persistent identities
or canonical time. Track evaluation and layer semantics belong to the document.
Source: crates/platinum-sdk/src/authoring/timeline.rs:1
platinum_sdk::authoring::timeline::Tick
pub type Tick
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:7
platinum_sdk::authoring::timeline::KeyId
pub type KeyId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:8
platinum_sdk::authoring::timeline::TrackId
pub type TrackId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:9
platinum_sdk::authoring::timeline::Interpolation
pub enum Interpolation
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:12
platinum_sdk::authoring::timeline::LayerMode
pub enum LayerMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:18
platinum_sdk::authoring::timeline::Key
pub struct Key
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | KeyId | |
| tick | Tick | |
| interpolation | Interpolation | |
Source: crates/platinum-sdk/src/authoring/timeline.rs:23
platinum_sdk::authoring::timeline::Track
pub struct Track
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | TrackId | |
| label | String | |
| muted | bool | |
| weight | f32 | |
| mode | LayerMode | |
| keys | Vec<Key> | |
Source: crates/platinum-sdk/src/authoring/timeline.rs:29
platinum_sdk::authoring::timeline::TimelineEdit
pub enum TimelineEdit
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:39
platinum_sdk::authoring::timeline::TimelineError
pub enum TimelineError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:71
platinum_sdk::authoring::timeline::validate
pub fn validate(tracks: &[Track]) -> Result<(), TimelineError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:77
platinum_sdk::authoring::timeline::snap_delta
pub fn snap_delta(delta: Tick, grid: Tick) -> Tick
Snap an offset to a positive grid. Arithmetic is widened before rounding;
negative half-grid values round away from zero, matching positive values.
Source: crates/platinum-sdk/src/authoring/timeline.rs:98
platinum_sdk::authoring::timeline::move_keys
pub fn move_keys(original: &BTreeMap<KeyId, Tick>, delta: Tick) -> BTreeMap<KeyId, Tick>
Clamp the whole gesture together, preserving intervals at time boundaries.
Source: crates/platinum-sdk/src/authoring/timeline.rs:106
platinum_sdk::authoring::timeline::Timeline
pub struct Timeline
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| selected | BTreeSet<KeyId> | |
| visible_start | Tick | |
| pixels_per_tick | f64 | |
| snap_ticks | Tick | |
Source: crates/platinum-sdk/src/authoring/timeline.rs:124
platinum_sdk::authoring::timeline::Timeline::is_editing
pub fn is_editing(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:155
platinum_sdk::authoring::timeline::Timeline::cancel
pub fn cancel(&mut self) -> Option<TimelineEdit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:158
platinum_sdk::authoring::timeline::Timeline::show
pub fn show(
&mut self,
ui: &mut Ui,
salt: impl std::hash::Hash,
tracks: &[Track],
playhead: Tick,
) -> Result<Vec<TimelineEdit>, TimelineError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/timeline.rs:166
platinum_sdk::office
platinum_sdk::office
Reusable Office-era widgets and host integration. Bevy owns all windows and rendering.
Source: crates/platinum-sdk/src/office.rs:1
platinum_sdk::office::FACE
pub const FACE: C
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:9
platinum_sdk::office::ACCENT
pub const ACCENT: C
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:10
platinum_sdk::office::MenuHost
pub struct MenuHost
A desktop shell sets external=true, presents these menus globally and sends CommandInvoked.
Public data fields| Name | Type / declaration | Description |
|---|
| external | bool | |
| menus | Vec<(String, Vec<(String, CommandId)>)> | |
Source: crates/platinum-sdk/src/office.rs:13
platinum_sdk::office::WindowKind
pub enum WindowKind
Host-level role determines taskbar, focus and stacking defaults.
Source: crates/platinum-sdk/src/office.rs:20
platinum_sdk::office::themed_window
pub fn themed_window(title: &str, size: (u32, u32), position: IVec2, kind: WindowKind) -> Window
Borderless host window defaults shared by documents, palettes and popup dialogs.
The caller can customize the returned Bevy Window before spawning it.
Source: crates/platinum-sdk/src/office.rs:27
platinum_sdk::office::SurfaceHandle
pub struct SurfaceHandle
Handles for a host window and its independently rendered egui camera/context.
Public data fields| Name | Type / declaration | Description |
|---|
| window | Entity | |
| camera | Entity | |
Source: crates/platinum-sdk/src/office.rs:58
platinum_sdk::office::spawn_host_surface
pub fn spawn_host_surface(commands: &mut Commands, window: Window) -> SurfaceHandle
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:62
platinum_sdk::office::application
pub fn application(title: &str) -> App
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:68
platinum_sdk::office::application_with_asset_path
pub fn application_with_asset_path(title: &str, asset_path: &str) -> App
Application host with an explicit asset directory, useful for standalone editors.
Source: crates/platinum-sdk/src/office.rs:72
platinum_sdk::office::configure
pub fn configure(ctx: &egui::Context)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:116
platinum_sdk::office::bevel
pub fn bevel(ui: &egui::Ui, r: Rect, sunken: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:197
platinum_sdk::office::ChromeAction
pub struct ChromeAction
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| close | bool | |
| minimize | bool | |
| maximize | bool | |
| drag | bool | |
| drag_offset | Option<V> | |
Source: crates/platinum-sdk/src/office.rs:215
platinum_sdk::office::title_bar
pub fn title_bar(ui: &mut egui::Ui, title: &str, active: bool, palette: bool) -> ChromeAction
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:222
platinum_sdk::office::apply_chrome
pub fn apply_chrome(window: &mut Window, a: ChromeAction, ctx: &egui::Context)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:318
platinum_sdk::office::resize_edges
pub fn resize_edges(ctx: &egui::Context, window: &mut Window)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:354
platinum_sdk::office::tool
pub fn tool(ui: &mut egui::Ui, label: &str, tooltip: &str) -> egui::Response
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:381
platinum_sdk::office::ruler
pub fn ruler(ui: &mut egui::Ui, width: f32, zoom: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:449
platinum_sdk::office::OfficeSurface
pub struct OfficeSurface(pub Entity)
Associates an independently rendered Bevy camera/context with its real host window.
Source: crates/platinum-sdk/src/office.rs:483
platinum_sdk::office::spawn_surface
pub fn spawn_surface(commands: &mut Commands, window: Entity) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office.rs:484
platinum_sdk::office::scrollbars
pub fn scrollbars<R>(ui: &mut egui::Ui, out: &egui::scroll_area::ScrollAreaOutput<R>)
Classic lavender scroll thumbs, arrow buttons and a dithered track.
The scroll area keeps wheel/keyboard scrolling; this supplies reusable themed pointer controls.
Source: crates/platinum-sdk/src/office.rs:495
platinum_sdk::office::section
pub fn section(
ui: &mut egui::Ui,
title: &str,
open_by_default: bool,
content: impl FnOnce(&mut egui::Ui),
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:3
platinum_sdk::office::color_well
pub fn color_well(ui: &mut egui::Ui, color: &mut [u8; 3], id: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:53
platinum_sdk::office::list_buttons
pub fn list_buttons(ui: &mut egui::Ui, doc: &mut RichDocument, editor: &RichEditorState)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:104
platinum_sdk::office::formatting_palette
pub fn formatting_palette(
ui: &mut egui::Ui,
doc: &mut RichDocument,
editor: &mut RichEditorState,
) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:119
platinum_sdk::office::SaveChoice
pub enum SaveChoice
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:408
platinum_sdk::office::DialogChoice
pub enum DialogChoice
A themed dialog returns intent; it does not close windows or perform host operations.
Source: crates/platinum-sdk/src/office_controls.rs:416
platinum_sdk::office::DialogSpec
pub struct DialogSpec<'a>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| title | &'a str | |
| message | &'a str | |
| detail | &'a str | |
| primary | &'a str | |
| secondary | Option<&'a str> | |
| cancel | Option<&'a str> | |
| icon | Option<Bitmap> | |
| width | f32 | |
Source: crates/platinum-sdk/src/office_controls.rs:421
platinum_sdk::office::confirmation_dialog
pub fn confirmation_dialog(
ui: &mut egui::Ui,
spec: &DialogSpec<'_>,
busy: bool,
) -> Option<DialogChoice>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:431
platinum_sdk::office::save_dialog
pub fn save_dialog(ui: &mut egui::Ui, name: &str, busy: bool) -> Option<SaveChoice>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:499
platinum_sdk::office::Bitmap
pub enum Bitmap
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:521
platinum_sdk::office::bitmap
pub fn bitmap(ui: &mut egui::Ui, icon: Bitmap, scale: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/office_controls.rs:526
platinum_sdk::office::table_editor
pub fn table_editor(ui: &mut egui::Ui, id: egui::Id, t: &mut DocumentTable, zoom: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/table_view.rs:66
platinum_sdk::office::PageViewState
pub struct PageViewState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| drag_request | Option<crate::file_manager::FileContent> | Host consumes this once to start a native/content drag outside the document context. |
| current_page | usize | |
| page_count | usize | |
Source: crates/platinum-sdk/src/paged_view.rs:19
platinum_sdk::rich_text::MAX_CHARACTERS
pub const MAX_CHARACTERS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:7
platinum_sdk::rich_text::Alignment
pub enum Alignment
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:10
platinum_sdk::rich_text::CharacterStyle
pub struct CharacterStyle
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| font_size | f32 | |
| bold | bool | |
| italic | bool | |
| underline | bool | |
| strike | bool | |
| sans | bool | |
| color | [u8; 3] | |
| alignment | Alignment | |
| highlight | Option<[u8; 3]> | |
| code | bool | |
| link | Option<String> | |
Source: crates/platinum-sdk/src/rich_text.rs:18
platinum_sdk::rich_text::StyleRun
pub struct StyleRun
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| start | usize | |
| end | usize | |
| style | CharacterStyle | |
Source: crates/platinum-sdk/src/rich_text.rs:49
platinum_sdk::rich_text::RichDocument
pub struct RichDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| format_version | u32 | |
| text | String | |
| style | CharacterStyle | |
| runs | Vec<StyleRun> | |
| page | PageStyle | |
| tables | Vec<DocumentTable> | |
| images | Vec<DocumentImage> | |
Source: crates/platinum-sdk/src/rich_text.rs:55
platinum_sdk::rich_text::RichDocument::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:82
platinum_sdk::rich_text::RichDocument::decode
pub fn decode(name: &str, content: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:121
platinum_sdk::rich_text::RichDocument::encode
pub fn encode(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:134
platinum_sdk::rich_text::RichDocument::style_at
pub fn style_at(&self, i: usize) -> CharacterStyle
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:137
platinum_sdk::rich_text::RichDocument::format
pub fn format(&mut self, range: Range<usize>, style: CharacterStyle)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:169
platinum_sdk::rich_text::RichDocument::replace_range
pub fn replace_range(&mut self, range: Range<usize>, text: &str, typing: &CharacterStyle)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:177
platinum_sdk::rich_text::RichDocument::sync_text
pub fn sync_text(&mut self, text: String, typing: &CharacterStyle)
Rebase character styles over Unicode insertions and deletions.
Source: crates/platinum-sdk/src/rich_text.rs:192
platinum_sdk::rich_text::RichDocument::slice
pub fn slice(&self, range: Range<usize>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:233
platinum_sdk::rich_text::RichDocument::html
pub fn html(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:260
platinum_sdk::rich_text::DocumentHistory
pub struct DocumentHistory
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:265
platinum_sdk::rich_text::DocumentHistory::record
pub fn record(&mut self, d: RichDocument, coalesce: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:270
platinum_sdk::rich_text::DocumentHistory::undo
pub fn undo(&mut self, current: &RichDocument) -> Option<RichDocument>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:279
platinum_sdk::rich_text::DocumentHistory::redo
pub fn redo(&mut self, current: &RichDocument) -> Option<RichDocument>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:284
platinum_sdk::rich_text::RichEditorState
pub struct RichEditorState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| selection | Range<usize> | |
| typing | CharacterStyle | |
| request_focus | bool | |
| selection_override | bool | |
| enabled | bool | |
| composing | bool | Shared live views observe this before accepting remote materializations. |
| ime_event_this_frame | bool | |
| external_undo | bool | Defaults false for legacy consumers; canonical views own selective undo. |
| undo_requested | Option<bool> | |
Source: crates/platinum-sdk/src/rich_text.rs:291
platinum_sdk::rich_text::RichEditorState::observe_ime
pub fn observe_ime(&mut self, context: &egui::Context, id: egui::Id)
Call before live-view synchronization, using this exact TextEdit ID.
Source: crates/platinum-sdk/src/rich_text.rs:321
platinum_sdk::rich_text::RichEditorState::apply
pub fn apply(&mut self, doc: &mut RichDocument, style: CharacterStyle)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:337
platinum_sdk::rich_text::rich_text_editor
pub fn rich_text_editor(
ui: &mut egui::Ui,
id: egui::Id,
doc: &mut RichDocument,
state: &mut RichEditorState,
zoom: f32,
) -> egui::Response
Embeddable mixed-format editor. Selection, caret and text share the shaped layout.
Source: crates/platinum-sdk/src/rich_text.rs:428
platinum_sdk::rich_text::rich_text_editor_sized
pub fn rich_text_editor_sized(
ui: &mut egui::Ui,
id: egui::Id,
doc: &mut RichDocument,
state: &mut RichEditorState,
zoom: f32,
minimum_height: f32,
) -> egui::Response
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:447
platinum_sdk::rich_text::rich_text_editor_decorated_sized
pub fn rich_text_editor_decorated_sized(
ui: &mut egui::Ui,
id: egui::Id,
doc: &mut RichDocument,
state: &mut RichEditorState,
zoom: f32,
minimum_height: f32,
decorations: &DecorationLayer,
) -> egui::Response
The standard rich editor with derived, view-local syntax/diagnostic formatting.
Decorations never modify source text, authored formatting or document undo.
Source: crates/platinum-sdk/src/rich_text.rs:467
platinum_sdk::rich_text::rich_text_editor_revisioned_sized
pub fn rich_text_editor_revisioned_sized(
ui: &mut egui::Ui,
id: egui::Id,
doc: &mut RichDocument,
state: &mut RichEditorState,
zoom: f32,
minimum_height: f32,
decorations: &DecorationLayer,
revision: u64,
) -> egui::Response
Revision-keyed variant for document models that increment the revision on
every text/style/page change. The widget ID must identify the document/view.
Unchanged frames avoid hashing the full source or serializing formatting.
Source: crates/platinum-sdk/src/rich_text.rs:481
platinum_sdk::rich_text::ListKind
pub enum ListKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:882
platinum_sdk::rich_text::RichDocument::apply_list
pub fn apply_list(&mut self, selection: Range<usize>, kind: ListKind)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text.rs:890
platinum_sdk::rich_text::decorations
platinum_sdk::rich_text::decorations
Derived view formatting. Character offsets match RichDocument; language byte
ranges must pass through `from_byte_range`, which rejects split UTF-8 values.
Source: crates/platinum-sdk/src/rich_text/decorations.rs:1
platinum_sdk::rich_text::decorations::StyleOverlay
pub struct StyleOverlay
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| foreground | Option<[u8; 3]> | |
| background | Option<Option<[u8; 3]>> | |
| bold | Option<bool> | |
| italic | Option<bool> | |
| underline | Option<bool> | |
| strike | Option<bool> | |
| code | Option<bool> | |
Source: crates/platinum-sdk/src/rich_text/decorations.rs:7
platinum_sdk::rich_text::decorations::TextDecoration
pub struct TextDecoration
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| characters | Range<usize> | |
| priority | i32 | Higher priority wins per property; equal priority uses input order. |
| style | StyleOverlay | |
Source: crates/platinum-sdk/src/rich_text/decorations.rs:42
platinum_sdk::rich_text::decorations::TextDecoration::from_byte_range
pub fn from_byte_range(
text: &str,
bytes: Range<usize>,
priority: i32,
style: StyleOverlay,
) -> Result<Self, &'static str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text/decorations.rs:49
platinum_sdk::rich_text::decorations::DecorationLayer
pub struct DecorationLayer
Compiled only when analysis changes. Lookups use disjoint segments rather
than scanning every token for each character while shaping a paragraph.
Source: crates/platinum-sdk/src/rich_text/decorations.rs:77
platinum_sdk::rich_text::decorations::DecorationLayer::compile
pub fn compile(
character_count: usize,
decorations: Vec<TextDecoration>,
) -> Result<Self, &'static str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text/decorations.rs:82
platinum_sdk::rich_text::decorations::DecorationLayer::fingerprint
pub fn fingerprint(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/rich_text/decorations.rs:144
platinum_sdk::theme
platinum_sdk::theme
Theme assets, policy resolution, input feedback and the opt-in modern corporate renderer.
Asset validation never authorizes applications or executes theme scripts.
Source: crates/platinum-sdk/src/theme.rs:1
platinum_sdk::theme::ThemeError
pub enum ThemeError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme.rs:11
platinum_sdk::theme::button
platinum_sdk::theme::button
Input normalization and feedback only: effects never authorize application work.
Source: crates/platinum-sdk/src/theme/button.rs:1
platinum_sdk::theme::button::ButtonState
pub enum ButtonState
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:5
platinum_sdk::theme::button::AsyncPhase
pub enum AsyncPhase
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:15
platinum_sdk::theme::button::Key
pub enum Key
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:23
platinum_sdk::theme::button::BackendOutcome
pub enum BackendOutcome
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:28
platinum_sdk::theme::button::UiCue
pub enum UiCue
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:33
platinum_sdk::theme::button::Effect
pub enum Effect
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:41
platinum_sdk::theme::button::ButtonEvent
pub enum ButtonEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:49
platinum_sdk::theme::button::AsyncTiming
pub struct AsyncTiming
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| start_ms | u16 | |
| hang_after_ms | u32 | |
| end_ms | u16 | |
Source: crates/platinum-sdk/src/theme/button.rs:66
platinum_sdk::theme::button::ButtonOptions
pub struct ButtonOptions
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reduced_motion | bool | |
| visited_asset | bool | |
| initially_visited | bool | |
| sound_cues | bool | |
| timing | AsyncTiming | |
Source: crates/platinum-sdk/src/theme/button.rs:81
platinum_sdk::theme::button::ButtonUpdate
pub struct ButtonUpdate
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ButtonState | |
| async_phase | AsyncPhase | |
| async_activation | Option<u64> | |
| effects | Vec<Effect> | |
Source: crates/platinum-sdk/src/theme/button.rs:89
platinum_sdk::theme::button::ButtonMachine
pub struct ButtonMachine
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:108
platinum_sdk::theme::button::ButtonMachine::new
pub fn new(options: ButtonOptions) -> Result<Self, ThemeError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/button.rs:122
platinum_sdk::theme::button::ButtonMachine::reduce
pub fn reduce(&mut self, event: ButtonEvent, now_ms: u64) -> Result<ButtonUpdate, ThemeError>
Clones only this bounded interaction state. Errors publish no effects or mutations.
Source: crates/platinum-sdk/src/theme/button.rs:145
platinum_sdk::theme::data::Guid
pub struct Guid([u8; 16])
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:5
platinum_sdk::theme::data::Guid::parse
pub fn parse(value: &str) -> Result<Self, ThemeError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:7
platinum_sdk::theme::data::ThemeAdapterRequest
pub enum ThemeAdapterRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:57
platinum_sdk::theme::data::ThemePolicy
pub struct ThemePolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| application | Guid | |
| builtin | ThemeAdapterRequest | |
| allow_user_theme_loading | bool | |
| application_preference | Option<ThemeAdapterRequest> | |
| system_default | Option<ThemeAdapterRequest> | |
| force_system | bool | |
| force_exclusions | BTreeSet<Guid> | |
Source: crates/platinum-sdk/src/theme/data.rs:62
platinum_sdk::theme::data::ThemePolicy::classic
pub fn classic(application: Guid) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:72
platinum_sdk::theme::data::resolve_theme
pub fn resolve_theme(policy: &ThemePolicy) -> Result<ThemeAdapterRequest, ThemeError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:84
platinum_sdk::theme::data::AssetReference
pub struct AssetReference
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| provider | Guid | |
| asset | Guid | |
| revision | u64 | |
Source: crates/platinum-sdk/src/theme/data.rs:105
platinum_sdk::theme::data::Color
pub struct Color
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| r | f32 | |
| g | f32 | |
| b | f32 | |
| a | f32 | |
Source: crates/platinum-sdk/src/theme/data.rs:111
platinum_sdk::theme::data::Insets
pub struct Insets
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| left | f32 | |
| right | f32 | |
| top | f32 | |
| bottom | f32 | |
Source: crates/platinum-sdk/src/theme/data.rs:125
platinum_sdk::theme::data::Metrics
pub struct Metrics
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| padding | Insets | |
| border | f32 | |
| radius | f32 | |
| scrollbar_thickness | f32 | |
| scrollbar_padding | f32 | |
Source: crates/platinum-sdk/src/theme/data.rs:132
platinum_sdk::theme::data::GradientStop
pub struct GradientStop
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| at | f32 | |
| color | Color | |
Source: crates/platinum-sdk/src/theme/data.rs:140
platinum_sdk::theme::data::Gradient
pub struct Gradient
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| angle_degrees | f32 | |
| stops | Vec<GradientStop> | |
Source: crates/platinum-sdk/src/theme/data.rs:145
platinum_sdk::theme::data::Material
pub struct Material
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| base | Color | |
| texture | Option<AssetReference> | |
| gradient | Option<Gradient> | |
Source: crates/platinum-sdk/src/theme/data.rs:150
platinum_sdk::theme::data::Parameter
pub enum Parameter
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:156
platinum_sdk::theme::data::StateRecipe
pub enum StateRecipe
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:163
platinum_sdk::theme::data::ElementKind
pub enum ElementKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:184
platinum_sdk::theme::data::ElementAsset
pub struct ElementAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| kind | ElementKind | |
| states | BTreeMap<String, StateRecipe> | |
Source: crates/platinum-sdk/src/theme/data.rs:189
platinum_sdk::theme::data::BUTTON_STATES
pub const BUTTON_STATES: [&str; 6]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:193
platinum_sdk::theme::data::StateReference
pub struct StateReference
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| element | String | |
| state | String | |
Source: crates/platinum-sdk/src/theme/data.rs:195
platinum_sdk::theme::data::AnimationRecipe
pub struct AnimationRecipe
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| start | StateReference | |
| loop_state | Option<StateReference> | |
| hang | Option<StateReference> | |
| end | StateReference | |
| reduced_motion | StateReference | |
| duration_ms | u16 | |
| interruptible | bool | |
Source: crates/platinum-sdk/src/theme/data.rs:200
platinum_sdk::theme::data::SoundTheme
pub struct SoundTheme
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reference | AssetReference | |
| window_spatial_ui | bool | |
Source: crates/platinum-sdk/src/theme/data.rs:210
platinum_sdk::theme::data::AudioDomain
pub enum AudioDomain
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:215
platinum_sdk::theme::data::SoundTheme::should_spatialize
pub fn should_spatialize(&self, domain: AudioDomain, already_spatialized: bool) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:223
platinum_sdk::theme::data::ThemeDescriptor
pub struct ThemeDescriptor
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| id | Guid | |
| name | String | |
| colors | BTreeMap<String, Color> | |
| materials | BTreeMap<String, Material> | |
| metrics | Metrics | |
| elements | BTreeMap<String, ElementAsset> | |
| animations | BTreeMap<String, AnimationRecipe> | |
| sound | Option<SoundTheme> | |
Source: crates/platinum-sdk/src/theme/data.rs:228
platinum_sdk::theme::data::ElementAsset::validate
pub fn validate(&self) -> Result<(), ThemeError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:264
platinum_sdk::theme::data::ThemeDescriptor::validate
pub fn validate(&self) -> Result<(), ThemeError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/data.rs:299
platinum_sdk::theme::renderer
platinum_sdk::theme::renderer
Actual egui procedural-theme consumer. No SDK renderer default is changed.
Supported provider is deliberately narrow; unsupported assets fail explicitly.
Source: crates/platinum-sdk/src/theme/renderer.rs:1
platinum_sdk::theme::renderer::Options
pub struct Options
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| touch | bool | |
| reduced_motion | bool | |
Source: crates/platinum-sdk/src/theme/renderer.rs:9
platinum_sdk::theme::renderer::RenderError
pub enum RenderError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:14
platinum_sdk::theme::renderer::RenderStats
pub struct RenderStats
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| compilations | u64 | |
| style_applications | u64 | |
| button_paints | u64 | |
| shapes_submitted | u64 | |
Source: crates/platinum-sdk/src/theme/renderer.rs:26
platinum_sdk::theme::renderer::Renderer
pub struct Renderer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| stats | RenderStats | |
Source: crates/platinum-sdk/src/theme/renderer.rs:46
platinum_sdk::theme::renderer::modern_id
pub fn modern_id() -> Guid
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:56
platinum_sdk::theme::renderer::provider_id
pub fn provider_id() -> Guid
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:59
platinum_sdk::theme::renderer::modern_corpo_descriptor
pub fn modern_corpo_descriptor() -> ThemeDescriptor
Exactly one original professional theme; density does not create a preset.
Source: crates/platinum-sdk/src/theme/renderer.rs:79
platinum_sdk::theme::renderer::Renderer::modern_corpo
pub fn modern_corpo(options: Options) -> Result<Self, RenderError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:157
platinum_sdk::theme::renderer::Renderer::compile
pub fn compile(descriptor: ThemeDescriptor, options: Options) -> Result<Self, RenderError>
Compile/validate once at load or config change, never in the draw loop.
Source: crates/platinum-sdk/src/theme/renderer.rs:161
platinum_sdk::theme::renderer::Renderer::apply_policy
pub fn apply_policy(
&mut self,
ctx: &egui::Context,
policy: &ThemePolicy,
) -> Result<(), RenderError>
Explicit Context opt-in. Baseline SDK/classic Style is retained verbatim.
Context-owned cache prevents repeated application across stable frames.
Source: crates/platinum-sdk/src/theme/renderer.rs:316
platinum_sdk::theme::renderer::Renderer::apply
pub fn apply(
&mut self,
ctx: &egui::Context,
request: &ThemeAdapterRequest,
) -> Result<(), RenderError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:323
platinum_sdk::theme::renderer::Renderer::paint_state
pub fn paint_state(
&mut self,
ui: &egui::Ui,
rect: egui::Rect,
label: &str,
state: ButtonState,
focused: bool,
) -> Result<(), RenderError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:373
platinum_sdk::theme::renderer::Renderer::button
pub fn button(
&mut self,
ui: &mut egui::Ui,
controller: &mut ButtonController,
label: &str,
enabled: bool,
now_ms: u64,
) -> Result<ButtonOutput, RenderError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:443
platinum_sdk::theme::renderer::ButtonController
pub struct ButtonController
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:515
platinum_sdk::theme::renderer::ButtonController::new
pub fn new(options: Options, visited: bool) -> Result<Self, RenderError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/theme/renderer.rs:523
platinum_sdk::theme::renderer::ButtonOutput
pub struct ButtonOutput
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| response | egui::Response | |
| state | ButtonState | |
| activations | Vec<u64> | |
Source: crates/platinum-sdk/src/theme/renderer.rs:612
platinum_sdk::script_editor
platinum_sdk::script_editor
Source editing through the same rich-text input/layout used by Write.
Parsing belongs to the language worker; paint consumes revision-tagged data.
Source: crates/platinum-sdk/src/script_editor.rs:1
platinum_sdk::script_editor::ScriptEditorView
pub struct ScriptEditorView
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| uri | String | |
Source: crates/platinum-sdk/src/script_editor.rs:12
platinum_sdk::script_editor::ScriptEditorResponse
pub struct ScriptEditorResponse
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| changed | bool | |
| query_needed | bool | |
| caret_byte | usize | |
Source: crates/platinum-sdk/src/script_editor.rs:29
platinum_sdk::script_editor::ScriptEditorView::new
pub fn new(uri: String, text: String) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:35
platinum_sdk::script_editor::ScriptEditorView::from_document
pub fn from_document(
uri: String,
source: SharedTextDocument,
revision: u64,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:39
platinum_sdk::script_editor::ScriptEditorView::fork_view
pub fn fork_view(&self) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:73
platinum_sdk::script_editor::ScriptEditorView::source
pub fn source(&self) -> SharedTextDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:76
platinum_sdk::script_editor::ScriptEditorView::pump
pub fn pump(&mut self) -> Result<bool, String>
Deferred host update. Source painting never dispatches authority commands.
Source: crates/platinum-sdk/src/script_editor.rs:80
platinum_sdk::script_editor::ScriptEditorView::has_uncommitted
pub fn has_uncommitted(&self) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:115
platinum_sdk::script_editor::ScriptEditorView::rebind_uri
pub fn rebind_uri(&mut self, uri: String)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:124
platinum_sdk::script_editor::ScriptEditorView::revision
pub fn revision(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:132
platinum_sdk::script_editor::ScriptEditorView::new_at_revision
pub fn new_at_revision(uri: String, text: String, revision: u64) -> Result<Self, String>
Reopened disk documents receive a new version after the project's prior
source index; a reload cannot accidentally reuse revision zero.
Source: crates/platinum-sdk/src/script_editor.rs:137
platinum_sdk::script_editor::ScriptEditorView::caret_byte
pub fn caret_byte(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:141
platinum_sdk::script_editor::ScriptEditorView::analysis
pub fn analysis(&self) -> Option<&Versioned<LanguageAssistance>>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:144
platinum_sdk::script_editor::ScriptEditorView::invalidate_dependencies
pub fn invalidate_dependencies(&mut self, catalog: u64, project: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:147
platinum_sdk::script_editor::ScriptEditorView::synchronize_text
pub fn synchronize_text(&mut self, text: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:182
platinum_sdk::script_editor::ScriptEditorView::accept_analysis
pub fn accept_analysis(
&mut self,
result: Versioned<LanguageAssistance>,
catalog: u64,
project: u64,
) -> Result<bool, String>
Both dependency identities come from the current worker, not the result.
Source: crates/platinum-sdk/src/script_editor.rs:196
platinum_sdk::script_editor::ScriptEditorView::apply_completion
pub fn apply_completion(&mut self, completion: &Completion) -> Result<(), &'static str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:261
platinum_sdk::script_editor::ScriptEditorView::show
pub fn show(&mut self, ui: &mut egui::Ui, id: egui::Id) -> ScriptEditorResponse
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/script_editor.rs:310
platinum_sdk::window_resources
platinum_sdk::window_resources
Bounded, opt-in tool-window measurements and resource advice. Timings are
observed CPU draw costs, not guessed GPU times or guaranteed FPS savings.
Source: crates/platinum-sdk/src/window_resources.rs:1
platinum_sdk::window_resources::WindowResourcePolicy
pub struct WindowResourcePolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| disposable | bool | |
| pinned | bool | |
| rendering_contexts | u32 | |
| estimated_bytes | Option<u64> | Application estimate, explicitly distinct from measured resident memory. |
Source: crates/platinum-sdk/src/window_resources.rs:7
platinum_sdk::window_resources::ResourceAdviceConfig
pub struct ResourceAdviceConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| minimum_fps | f64 | |
| sustained_seconds | f64 | |
| samples | u32 | |
| cooldown_seconds | f64 | |
| recent_use_seconds | f64 | |
| maximum_windows | usize | |
Source: crates/platinum-sdk/src/window_resources.rs:15
platinum_sdk::window_resources::WindowResourceReport
pub struct WindowResourceReport
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| cpu_draw_mean_ms | Option<f64> | |
| cpu_draw_peak_ms | Option<f64> | |
| measured_samples | u32 | |
| rendering_contexts | u32 | |
| estimated_bytes | Option<u64> | |
| idle_seconds | f64 | |
| may_offer_close | bool | |
Source: crates/platinum-sdk/src/window_resources.rs:38
platinum_sdk::window_resources::WindowResourceAdvisor
pub struct WindowResourceAdvisor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:58
platinum_sdk::window_resources::WindowResourceAdvisor::new
pub fn new(config: ResourceAdviceConfig) -> Result<Self, &'static str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:73
platinum_sdk::window_resources::WindowResourceAdvisor::register
pub fn register(
&mut self,
id: String,
name: String,
policy: WindowResourcePolicy,
now: f64,
) -> Result<(), &'static str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:97
platinum_sdk::window_resources::WindowResourceAdvisor::unregister
pub fn unregister(&mut self, id: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:137
platinum_sdk::window_resources::WindowResourceAdvisor::set_policy
pub fn set_policy(&mut self, id: &str, policy: WindowResourcePolicy) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:140
platinum_sdk::window_resources::WindowResourceAdvisor::used
pub fn used(&mut self, id: &str, now: f64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:148
platinum_sdk::window_resources::WindowResourceAdvisor::observe_frame
pub fn observe_frame(&mut self, now: f64, explained_slowdown: bool)
Set explained_slowdown during known builds/imports/loading/pauses. No
blanket application-wide permanent instrumentation is enabled by this.
Source: crates/platinum-sdk/src/window_resources.rs:157
platinum_sdk::window_resources::WindowResourceAdvisor::request_profile
pub fn request_profile(&mut self, now: f64)
Used by a runtime's developer profiling command as well as auto advice.
Source: crates/platinum-sdk/src/window_resources.rs:196
platinum_sdk::window_resources::WindowResourceAdvisor::sampling
pub fn sampling(&self, id: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:209
platinum_sdk::window_resources::WindowResourceAdvisor::record_cpu_draw
pub fn record_cpu_draw(&mut self, id: &str, milliseconds: f64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:216
platinum_sdk::window_resources::WindowResourceAdvisor::take_notice
pub fn take_notice(&mut self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:232
platinum_sdk::window_resources::WindowResourceAdvisor::report
pub fn report(&self, now: f64) -> Vec<WindowResourceReport>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/window_resources.rs:235
platinum_sdk::runtime_supervision
platinum_sdk::runtime_supervision
Native host-owned child lifecycle. This does not authenticate executable
publishers or expose a wire launch API. Children are owned OS handles, never
a caller-supplied PID/GUID. A timeout never creates a second authority writer.
Source: crates/platinum-sdk/src/runtime_supervision.rs:1
platinum_sdk::runtime_supervision::ProcessRole
pub enum ProcessRole
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:9
platinum_sdk::runtime_supervision::ProcessHealth
pub enum ProcessHealth
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:17
platinum_sdk::runtime_supervision::SupervisionPolicy
pub struct SupervisionPolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| ready_timeout_ms | u64 | |
| heartbeat_timeout_ms | u64 | |
| request_timeout_ms | u64 | |
| progress_timeout_ms | u64 | |
| crash_window_ms | u64 | |
| maximum_restarts | usize | |
| maximum_pending_requests | usize | |
Source: crates/platinum-sdk/src/runtime_supervision.rs:25
platinum_sdk::runtime_supervision::ProcessHandle
pub struct ProcessHandle
Coordinator-local attachment, not a serialized credential. A restarted
process receives a new generation; old callbacks cannot mark it ready.
Source: crates/platinum-sdk/src/runtime_supervision.rs:65
platinum_sdk::runtime_supervision::SupervisionError
pub enum SupervisionError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:76
platinum_sdk::runtime_supervision::ProcessObservation
pub struct ProcessObservation
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| handle | ProcessHandle | |
| role | ProcessRole | |
| health | ProcessHealth | |
| admission_open | bool | |
| exit_code | Option<i32> | |
| oldest_request_age_ms | Option<u64> | |
Source: crates/platinum-sdk/src/runtime_supervision.rs:117
platinum_sdk::runtime_supervision::ChildRegistrationError
pub struct ChildRegistrationError
Registration failure returns ownership instead of orphaning a running child.
Public data fields| Name | Type / declaration | Description |
|---|
| error | SupervisionError | |
| child | Child | |
Source: crates/platinum-sdk/src/runtime_supervision.rs:127
platinum_sdk::runtime_supervision::RecoveryContext
pub struct RecoveryContext<'a>
Exact application-owned command receipt keys. The host must bind these to
the original authenticated attachment and bytes before querying receipts.
Public data fields| Name | Type / declaration | Description |
|---|
| role | ProcessRole | |
| previous_generation | u64 | |
| uncertain_request_keys | &'a [String] | |
Source: crates/platinum-sdk/src/runtime_supervision.rs:133
platinum_sdk::runtime_supervision::ProcessRecoveryHost
pub trait ProcessRecoveryHost
Trusted configured runtime adapter. There is no permissive default.
Data/backend recovery must fence the old lease and validate durable state;
presentation recovery must reconstruct from canonical data, not rerun rules.
Source: crates/platinum-sdk/src/runtime_supervision.rs:141
platinum_sdk::runtime_supervision::ChildSupervisor
pub struct ChildSupervisor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:162
platinum_sdk::runtime_supervision::ChildSupervisor::new
pub fn new(maximum: usize) -> Result<Self, SupervisionError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:170
platinum_sdk::runtime_supervision::ChildSupervisor::register
pub fn register(
&mut self,
child: Child,
role: ProcessRole,
policy: SupervisionPolicy,
now: u64,
) -> Result<ProcessHandle, ChildRegistrationError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:198
platinum_sdk::runtime_supervision::ChildSupervisor::restored_ready
pub fn restored_ready(
&mut self,
handle: &ProcessHandle,
now: u64,
) -> Result<(), SupervisionError>
Called after authenticated reattachment, capability renewal and restore
validation, not merely on process creation or the first heartbeat.
Source: crates/platinum-sdk/src/runtime_supervision.rs:242
platinum_sdk::runtime_supervision::ChildSupervisor::heartbeat
pub fn heartbeat(&mut self, handle: &ProcessHandle, now: u64) -> Result<(), SupervisionError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:257
platinum_sdk::runtime_supervision::ChildSupervisor::request_started
pub fn request_started(
&mut self,
handle: &ProcessHandle,
key: String,
now: u64,
) -> Result<(), SupervisionError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:263
platinum_sdk::runtime_supervision::ChildSupervisor::request_progress
pub fn request_progress(
&mut self,
handle: &ProcessHandle,
key: &str,
progress: u64,
now: u64,
) -> Result<(), SupervisionError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:293
platinum_sdk::runtime_supervision::ChildSupervisor::request_completed
pub fn request_completed(
&mut self,
handle: &ProcessHandle,
key: &str,
now: u64,
) -> Result<(), SupervisionError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/runtime_supervision.rs:312
platinum_sdk::runtime_supervision::ChildSupervisor::poll
pub fn poll(&mut self, now: u64) -> Result<Vec<ProcessObservation>, SupervisionError>
Nonblocking OS process checks plus work-age/progress checks. Emits only
transitions; a responsive heartbeat cannot conceal a stuck request.
Source: crates/platinum-sdk/src/runtime_supervision.rs:327
platinum_sdk::runtime_supervision::ChildSupervisor::recover
pub fn recover(
&mut self,
handle: &ProcessHandle,
host: &mut dyn ProcessRecoveryHost,
now: u64,
) -> Result<ProcessHandle, SupervisionError>
No automatic kill. The host requests a graceful stop/fences capabilities
outside this module; recovery waits for the owned OS child to exit.
Source: crates/platinum-sdk/src/runtime_supervision.rs:381
platinum_sdk::runtime_supervision::ChildSupervisor::remove_exited
pub fn remove_exited(&mut self, handle: &ProcessHandle) -> Result<(), SupervisionError>
Drop of the coordinator deliberately does not kill an independent data
authority. Explicit host shutdown owns termination and lease release.
Source: crates/platinum-sdk/src/runtime_supervision.rs:439
platinum_sdk::live_text
platinum_sdk::live_text
One accepted sequence document shared by many editor views. Host adapters
authenticate commits before calling this module; this is not an IPC endpoint.
Source: crates/platinum-sdk/src/live_text.rs:1
platinum_sdk::live_text::LiveTextDocument
pub struct LiveTextDocument
Views share this model, not copies of the world's authoritative document.
Text is materialized once per accepted change, never on an unchanged paint.
Source: crates/platinum-sdk/src/live_text.rs:18
platinum_sdk::live_text::LiveTextDocument::attach
pub fn attach(
snapshot: Snapshot,
expected: &DocumentRef,
field: String,
limits: LiveLimits,
schema: Option<Arc<ValidatedSchema>>,
) -> Result<Self, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:161
platinum_sdk::live_text::LiveTextDocument::snapshot
pub fn snapshot(&self) -> &Arc<Snapshot>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:187
platinum_sdk::live_text::LiveTextDocument::text
pub fn text(&self) -> &Arc<str>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:190
platinum_sdk::live_text::LiveTextDocument::revision
pub fn revision(&self) -> Generation
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:193
platinum_sdk::live_text::LiveTextDocument::durable_revision
pub fn durable_revision(&self) -> Option<Generation>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:196
platinum_sdk::live_text::LiveTextDocument::saved_revision
pub fn saved_revision(&self) -> Option<Generation>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:199
platinum_sdk::live_text::LiveTextDocument::is_saved
pub fn is_saved(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:202
platinum_sdk::live_text::LiveTextDocument::accept
pub fn accept(&mut self, commit: &Commit) -> Result<(), LiveError>
Ordered canonical effects only. A duplicate/gap returns an error instead
of acknowledging a state that this view never accepted.
Source: crates/platinum-sdk/src/live_text.rs:207
platinum_sdk::live_text::LiveTextDocument::acknowledge_durable
pub fn acknowledge_durable(&mut self, revision: Generation) -> Result<(), &'static str>
Only a host's persistence receipt may call this; accepted != durable.
Source: crates/platinum-sdk/src/live_text.rs:218
platinum_sdk::live_text::LiveTextDocument::acknowledge_saved
pub fn acknowledge_saved(&mut self, written: &Snapshot) -> Result<(), LiveError>
Capture the exact immutable snapshot written, so a late save cannot mark
newer text saved. The file provider supplies this receipt after success.
Source: crates/platinum-sdk/src/live_text.rs:227
platinum_sdk::live_text::LiveTextDocument::view
pub fn view(&self, style: CharacterStyle) -> LiveTextView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:242
platinum_sdk::live_text::LiveTextView
pub struct LiveTextView
Selection/IME/scroll/camera/decorations are view local. A composing draft
retains its original atom identities while other views accept remote edits.
Public data fields| Name | Type / declaration | Description |
|---|
| document | RichDocument | |
| editor | RichEditorState | |
Source: crates/platinum-sdk/src/live_text.rs:263
platinum_sdk::live_text::LiveTextView::selection_anchors
pub fn selection_anchors(&self) -> Result<[TextAnchor; 2], LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:278
platinum_sdk::live_text::LiveTextView::is_pending
pub fn is_pending(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:380
platinum_sdk::live_text::LiveTextView::is_dirty
pub fn is_dirty(&self) -> Result<bool, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text.rs:383
platinum_sdk::live_text::LiveTextView::synchronize
pub fn synchronize(&mut self, model: &LiveTextDocument) -> Result<bool, LiveError>
A clean view adopts the current materialization; a composing view keeps
its anchored draft and can submit against its older CRDT base safely.
Source: crates/platinum-sdk/src/live_text.rs:388
platinum_sdk::live_text::LiveTextView::prepare
pub fn prepare(&mut self, operation: Generation) -> Result<Option<Transaction>, LiveError>
One immutable in-flight operation per view. The host either commits it
synchronously or retains it for exact retry; do not allocate a new ID for
an unknown outcome. Pending views remain selectable but read-only.
Source: crates/platinum-sdk/src/live_text.rs:417
platinum_sdk::live_text::LiveTextView::confirm
pub fn confirm(
&mut self,
committed: &Transaction,
model: &LiveTextDocument,
) -> Result<(), LiveError>
The adapter must match authenticated principal/session as well as this
operation before calling; operation numbers alone are not identities.
Source: crates/platinum-sdk/src/live_text.rs:439
platinum_sdk::live_text::LiveTextView::reject
pub fn reject(&mut self)
Explicit rejection releases the draft for correction. Transport timeout
is an unknown outcome and must use exact retry, not this method.
Source: crates/platinum-sdk/src/live_text.rs:457
platinum_sdk::live_text::backend
platinum_sdk::live_text::backend
Embedded, volatile canonical authority adapter. Accepted is never durable.
No transport, publisher admission or durable recovery is supplied here.
Source: crates/platinum-sdk/src/live_text/backend.rs:1
platinum_sdk::live_text::backend::MAX_SOURCE_BYTES
pub const MAX_SOURCE_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:17
platinum_sdk::live_text::backend::MAX_SOURCE_CHARACTERS
pub const MAX_SOURCE_CHARACTERS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:18
platinum_sdk::live_text::backend::SharedTextDocument
pub struct SharedTextDocument(Arc<Mutex<Backend>>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:23
platinum_sdk::live_text::backend::SharedTextDocument::restore_export
pub fn restore_export(
export: &super::recoverable_save::SavedTextMedia,
source_text: &str,
) -> Result<(Self, super::media::MediaSidecar), String>
Explicit file import into a fresh authority/resource incarnation. Atom
identities survive for media anchors; connections, receipts and history
do not. The caller must have read the authorized exact source/metadata
pair and must not treat this export as a continuation checkpoint.
Source: crates/platinum-sdk/src/live_text/backend.rs:132
platinum_sdk::live_text::backend::SharedTextDocument::embedded
pub fn embedded(text: &str) -> Result<Self, LiveError>
Trusted local host construction. All views share this same authority,
document incarnation and accepted sequence; no singleton swapping.
Source: crates/platinum-sdk/src/live_text/backend.rs:184
platinum_sdk::live_text::backend::SharedTextDocument::open_view
pub fn open_view(&self, style: CharacterStyle) -> Result<BoundTextView, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:242
platinum_sdk::live_text::backend::SharedTextDocument::text
pub fn text(&self) -> Result<Arc<str>, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:273
platinum_sdk::live_text::backend::SharedTextDocument::snapshot
pub fn snapshot(&self) -> Result<Arc<Snapshot>, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:282
platinum_sdk::live_text::backend::SharedTextDocument::save_snapshot
pub fn save_snapshot(&self) -> Result<(Arc<Snapshot>, Arc<str>), LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:291
platinum_sdk::live_text::backend::SharedTextDocument::is_saved
pub fn is_saved(&self) -> Result<bool, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:295
platinum_sdk::live_text::backend::SharedTextDocument::acknowledge_saved
pub fn acknowledge_saved(&self, written: &Snapshot) -> Result<(), LiveError>
Called only after successful provider save of this exact snapshot.
Does not acknowledge the authority's volatile memory as durable storage.
Source: crates/platinum-sdk/src/live_text/backend.rs:305
platinum_sdk::live_text::backend::BoundTextView
pub struct BoundTextView
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| source | SharedTextDocument | |
| view | LiveTextView | |
Source: crates/platinum-sdk/src/live_text/backend.rs:333
platinum_sdk::live_text::backend::BoundTextView::synchronize
pub fn synchronize(&mut self) -> Result<bool, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:346
platinum_sdk::live_text::backend::BoundTextView::prepare
pub fn prepare(&mut self) -> Result<Option<Transaction>, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:350
platinum_sdk::live_text::backend::BoundTextView::flush
pub fn flush(&mut self) -> Result<bool, LiveError>
Execute on the host update/command lane, never as part of widget paint.
Any error preserves a pending exact transaction for explicit retry.
Source: crates/platinum-sdk/src/live_text/backend.rs:443
platinum_sdk::live_text::backend::BoundTextView::undo
pub fn undo(&mut self) -> Result<bool, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:452
platinum_sdk::live_text::backend::BoundTextView::redo
pub fn redo(&mut self) -> Result<bool, LiveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/backend.rs:455
platinum_sdk::live_text::media
platinum_sdk::live_text::media
Stable-anchor media sidecars and authorized image-surface presentation.
This module does not decode video or start a second gameplay world.
Source: crates/platinum-sdk/src/live_text/media.rs:1
platinum_sdk::live_text::media::MEDIA_SIDECAR_VERSION
pub const MEDIA_SIDECAR_VERSION: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:11
platinum_sdk::live_text::media::MAX_MEDIA_EMBEDS
pub const MAX_MEDIA_EMBEDS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:12
platinum_sdk::live_text::media::MAX_MEDIA_SIDECAR_BYTES
pub const MAX_MEDIA_SIDECAR_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:13
platinum_sdk::live_text::media::MediaSidecarRole
pub enum MediaSidecarRole
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:17
platinum_sdk::live_text::media::MediaSidecar
pub struct MediaSidecar
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| role | MediaSidecarRole | |
| document | DocumentRef | |
| field | String | |
| source_path | String | |
| saved_source_revision | Generation | Receipt for source/metadata save coordination; this is not an asset revision. |
| embeds | Vec<MediaEmbed> | |
Source: crates/platinum-sdk/src/live_text/media.rs:22
platinum_sdk::live_text::media::MediaEmbed
pub struct MediaEmbed
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| anchor | TextAnchor | |
| source | MediaSource | |
| placement | MediaPlacement | |
| title | String | |
Source: crates/platinum-sdk/src/live_text/media.rs:34
platinum_sdk::live_text::media::MediaSource
pub enum MediaSource
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:43
platinum_sdk::live_text::media::MediaSceneSession
pub enum MediaSceneSession
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:63
platinum_sdk::live_text::media::MediaAssetRef
pub struct MediaAssetRef
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | Option<String> | |
| path | Option<String> | |
| revision | Option<String> | |
Source: crates/platinum-sdk/src/live_text/media.rs:71
platinum_sdk::live_text::media::MediaLayer
pub enum MediaLayer
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:78
platinum_sdk::live_text::media::MediaPlacement
pub struct MediaPlacement
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| layer | MediaLayer | |
| size | [f32; 2] | |
| offset | [f32; 2] | |
| opacity | f32 | |
Source: crates/platinum-sdk/src/live_text/media.rs:85
platinum_sdk::live_text::media::media_sidecar_path
pub fn media_sidecar_path(source_path: &str) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:113
platinum_sdk::live_text::media::is_media_sidecar
pub fn is_media_sidecar(path: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:127
platinum_sdk::live_text::media::MediaSidecar::decode
pub fn decode(text: &str, expected: &DocumentRef, field: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:177
platinum_sdk::live_text::media::MediaSidecar::validate
pub fn validate(&self, expected: &DocumentRef, field: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:185
platinum_sdk::live_text::media::MediaAnchorGeometry
pub struct MediaAnchorGeometry
Geometry belongs to the current view's derived text layout, not the document.
Public data fields| Name | Type / declaration | Description |
|---|
| revision | Generation | |
| layout_revision | u64 | |
| rect | egui::Rect | |
Source: crates/platinum-sdk/src/live_text/media.rs:223
platinum_sdk::live_text::media::MediaAnchorResolver
pub trait MediaAnchorResolver
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:228
platinum_sdk::live_text::media::ResolvedMediaPlacement
pub struct ResolvedMediaPlacement
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| embed_id | String | |
| layer | MediaLayer | |
| rect | egui::Rect | |
| opacity | f32 | |
Source: crates/platinum-sdk/src/live_text/media.rs:240
platinum_sdk::live_text::media::resolve_media_layout
pub fn resolve_media_layout(
sidecar: &MediaSidecar,
resolver: &impl MediaAnchorResolver,
revision: Generation,
layout_revision: u64,
) -> Vec<(String, Result<ResolvedMediaPlacement, String>)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:246
platinum_sdk::live_text::media::MediaConsumer
pub struct MediaConsumer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| application | String | |
| launch | String | |
| view | String | |
Source: crates/platinum-sdk/src/live_text/media.rs:283
platinum_sdk::live_text::media::MediaSurfaceRequest
pub struct MediaSurfaceRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| document | DocumentRef | |
| embed_id | String | |
| source | MediaSource | |
| consumer | MediaConsumer | |
| pixels | [u32; 2] | |
Source: crates/platinum-sdk/src/live_text/media.rs:289
platinum_sdk::live_text::media::MediaAuthorization
pub trait MediaAuthorization: Send + Sync
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:296
platinum_sdk::live_text::media::MediaSurfaceLease
pub struct MediaSurfaceLease
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| host_epoch | u64 | |
| id | u64 | |
| generation | u64 | |
Source: crates/platinum-sdk/src/live_text/media.rs:302
platinum_sdk::live_text::media::MediaSurfaceEvent
pub enum MediaSurfaceEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:308
platinum_sdk::live_text::media::MediaSurfacePresentation
pub enum MediaSurfacePresentation
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:322
platinum_sdk::live_text::media::MediaImageSurfaceHost
pub struct MediaImageSurfaceHost<A: MediaAuthorization>
Actual Bevy-image adapter. A viewport renderer or video decoder publishes a
real Image handle; the host never substitutes a claimed playable video.
Source: crates/platinum-sdk/src/live_text/media.rs:341
platinum_sdk::live_text::media::MediaImageSurfaceHost::new
pub fn new(authorization: A, host_epoch: u64, max_surfaces: usize) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:350
platinum_sdk::live_text::media::MediaImageSurfaceHost::acquire
pub fn acquire(&mut self, request: MediaSurfaceRequest) -> Result<MediaSurfaceLease, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:363
platinum_sdk::live_text::media::MediaImageSurfaceHost::poll_event
pub fn poll_event(&mut self) -> Option<MediaSurfaceEvent>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:419
platinum_sdk::live_text::media::MediaImageSurfaceHost::presentation
pub fn presentation(
&self,
lease: MediaSurfaceLease,
consumer: &MediaConsumer,
) -> Result<MediaSurfacePresentation, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:422
platinum_sdk::live_text::media::MediaImageSurfaceHost::unavailable
pub fn unavailable(
&mut self,
lease: MediaSurfaceLease,
consumer: &MediaConsumer,
reason: &str,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:429
platinum_sdk::live_text::media::MediaImageSurfaceHost::publish_image
pub fn publish_image(
&mut self,
lease: MediaSurfaceLease,
consumer: &MediaConsumer,
frame: u64,
image: Handle<Image>,
images: &Assets<Image>,
textures: &mut EguiUserTextures,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:441
platinum_sdk::live_text::media::MediaImageSurfaceHost::resize
pub fn resize(
&mut self,
lease: MediaSurfaceLease,
consumer: &MediaConsumer,
pixels: [u32; 2],
) -> Result<MediaSurfaceLease, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:477
platinum_sdk::live_text::media::MediaImageSurfaceHost::release
pub fn release(
&mut self,
lease: MediaSurfaceLease,
consumer: &MediaConsumer,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:509
platinum_sdk::live_text::media::MediaImageSurfaceHost::close_consumer
pub fn close_consumer(&mut self, consumer: &MediaConsumer)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/media.rs:528
platinum_sdk::live_text::media::paint_media_surface
pub fn paint_media_surface(
painter: &egui::Painter,
clip: egui::Rect,
placement: &ResolvedMediaPlacement,
stage: MediaLayer,
presentation: &MediaSurfacePresentation,
)
Paint the matching stage before/after the shared text widget. Inline rects
must first be reserved by the host's layout adapter; no source characters are
inserted to manufacture spacing. Error/pending output is explicitly labeled.
Source: crates/platinum-sdk/src/live_text/media.rs:548
platinum_sdk::live_text::recoverable_save
platinum_sdk::live_text::recoverable_save
Recoverable source/metadata pair writes on a host command/worker lane.
The journal is a roll-forward intent, not an authority checkpoint or a durable
Live commit receipt. Providers must serialize every alias of the same pair.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:1
platinum_sdk::live_text::recoverable_save::MAX_METADATA_BYTES
pub const MAX_METADATA_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:9
platinum_sdk::live_text::recoverable_save::SavedTextMedia
pub struct SavedTextMedia
Retains atom identities for media anchors, including tombstones. Importing
this export requires a new authority incarnation; it cannot restore dedupe,
authenticated sessions, outstanding commands, or authority continuations.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| source | Snapshot | |
| media | MediaSidecar | |
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:19
platinum_sdk::live_text::recoverable_save::SavedTextMedia::validate
pub fn validate(&self, source_text: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:25
platinum_sdk::live_text::recoverable_save::SavedTextMedia::encode
pub fn encode(&self, source_text: &str) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:58
platinum_sdk::live_text::recoverable_save::SavedTextMedia::decode
pub fn decode(metadata: &str, source_text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:66
platinum_sdk::live_text::recoverable_save::FilePair
pub struct FilePair
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| source | Option<Vec<u8>> | None is a file which does not exist, rather than an empty file. |
| metadata | Option<Vec<u8>> | |
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:91
platinum_sdk::live_text::recoverable_save::FilePair::from_export
pub fn from_export(source: &str, metadata: &SavedTextMedia) -> Result<Self, SaveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:111
platinum_sdk::live_text::recoverable_save::SaveError
pub enum SaveError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:138
platinum_sdk::live_text::recoverable_save::PairAccess
pub trait PairAccess
The host holds a pair-exclusive guard for the entire operation. No callback
here executes on paint, and no successful write implies a Live durable ACK.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:150
platinum_sdk::live_text::recoverable_save::PairNames
pub struct PairNames
Names are derived from one validated source leaf in one provisioned folder.
There are no journal-controlled paths and no ambient path resolution.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:158
platinum_sdk::live_text::recoverable_save::PairNames::new
pub fn new(source_leaf: &str) -> Result<Self, SaveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:164
platinum_sdk::live_text::recoverable_save::PairNames::read
pub fn read(&self, access: &mut impl PairAccess) -> Result<FilePair, SaveError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:203
platinum_sdk::live_text::recoverable_save::PairNames::recover
pub fn recover(&self, access: &mut impl PairAccess) -> Result<Option<FilePair>, SaveError>
None means no pending intent. Unknown external edits never get replaced
by recovery: all current files must equal either their old or new bytes.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:247
platinum_sdk::live_text::recoverable_save::PairNames::save
pub fn save(
&self,
access: &mut impl PairAccess,
expected: &FilePair,
new: &FilePair,
) -> Result<(), SaveError>
`expected` is the last exact disk observation. Call recover separately
first; an uncertain earlier operation must not be silently overwritten.
Source: crates/platinum-sdk/src/live_text/recoverable_save.rs:284
platinum_sdk::live_text::recoverable_save::TextMediaFile
pub struct TextMediaFile
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save/session.rs:7
platinum_sdk::live_text::recoverable_save::TextMediaFile::open
pub fn open(
access: &mut impl PairAccess,
names: PairNames,
source_path: &str,
) -> Result<(Self, SharedTextDocument, MediaSidecar), SaveError>
Authorized host file-open command. Recover under the provider's exclusive
pair guard before exposing either file. Paths are routing, not authority.
Source: crates/platinum-sdk/src/live_text/recoverable_save/session.rs:21
platinum_sdk::live_text::recoverable_save::TextMediaFile::has_pending_save
pub fn has_pending_save(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save/session.rs:88
platinum_sdk::live_text::recoverable_save::TextMediaFile::retarget
pub fn retarget(&mut self, names: PairNames) -> Result<(), SaveError>
Trusted host rename/move hook, called after moving both files. Retain the
previous exact baseline so an external edit still conflicts on next save.
Source: crates/platinum-sdk/src/live_text/recoverable_save/session.rs:93
platinum_sdk::live_text::recoverable_save::TextMediaFile::save
pub fn save(
&mut self,
access: &mut impl PairAccess,
source: &SharedTextDocument,
media: &MediaSidecar,
) -> Result<(Arc<Snapshot>, Arc<str>), SaveError>
Capture the exact accepted snapshot once. If a prior disk save is
uncertain, complete that exact operation first, then save the new cut.
Media edits must already have been accepted by their owning authority.
Source: crates/platinum-sdk/src/live_text/recoverable_save/session.rs:136
platinum_sdk::live_text::recoverable_save::native
platinum_sdk::live_text::recoverable_save::native
Native host-only provider. OS advisory locking is released on process exit.
Neither native file sync nor this journal is a LiveAuthority durable receipt.
Source: crates/platinum-sdk/src/live_text/recoverable_save/native.rs:1
platinum_sdk::live_text::recoverable_save::native::NativePairGuard
pub struct NativePairGuard
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_text/recoverable_save/native.rs:9
platinum_sdk::live_text::recoverable_save::native::NativePairGuard::try_acquire
pub fn try_acquire(directory: Dir, names: &PairNames) -> Result<Self, SaveError>
`directory` is provisioned by the trusted host, not a wire path. Hosts
serialize aliases and must keep the directory/lock entry immutable to
untrusted writers. Permission to read a document does not grant this API.
Source: crates/platinum-sdk/src/live_text/recoverable_save/native.rs:18
platinum_sdk::live_assets
platinum_sdk::live_assets
Shared accepted asset projections and drafts over the existing LiveAuthority.
This is not another authority, durable store, socket or authentication broker.
Source: crates/platinum-sdk/src/live_assets.rs:1
platinum_sdk::live_assets::AssetValidator
pub type AssetValidator
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:14
platinum_sdk::live_assets::AssetKey
pub struct AssetKey
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| project | String | |
| asset | String | |
| kind | String | |
Source: crates/platinum-sdk/src/live_assets.rs:16
platinum_sdk::live_assets::AssetBinding
pub struct AssetBinding
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| key | AssetKey | |
| document | DocumentRef | |
| field | String | |
Source: crates/platinum-sdk/src/live_assets.rs:22
platinum_sdk::live_assets::AssetCommitError
pub enum AssetCommitError
Already authenticated, resource-bound endpoint. Implementations use the SDK's
accepted transport/authority APIs; keys/paths never mint grants.
Source: crates/platinum-sdk/src/live_assets.rs:30
platinum_sdk::live_assets::AssetCommitResolution
pub enum AssetCommitResolution
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:35
platinum_sdk::live_assets::AssetAuthorityPort
pub trait AssetAuthorityPort: Send + Sync
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:40
platinum_sdk::live_assets::AssetDraft
pub struct AssetDraft
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| view | String | |
| base_revision | Generation | |
| value | Arc<Value> | |
Source: crates/platinum-sdk/src/live_assets.rs:51
platinum_sdk::live_assets::AssetPreview
pub struct AssetPreview
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| generation | u64 | |
| owner | String | |
| base_revision | Generation | |
| body | Arc<Value> | |
Source: crates/platinum-sdk/src/live_assets.rs:57
platinum_sdk::live_assets::AssetProjection
pub struct AssetProjection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| revision | Generation | |
| body | Arc<Value> | |
| preview | Option<AssetPreview> | |
Source: crates/platinum-sdk/src/live_assets.rs:64
platinum_sdk::live_assets::AssetEditFailure
pub struct AssetEditFailure
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reason | String | |
| draft | AssetDraft | |
Source: crates/platinum-sdk/src/live_assets.rs:70
platinum_sdk::live_assets::LiveAssetHandle
pub struct LiveAssetHandle(Arc<Document>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:93
platinum_sdk::live_assets::LiveAssetHandle::binding
pub fn binding(&self) -> &AssetBinding
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:95
platinum_sdk::live_assets::LiveAssetHandle::same_document
pub fn same_document(&self, other: &Self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:98
platinum_sdk::live_assets::LiveAssetHandle::projection
pub fn projection(&self) -> Result<AssetProjection, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:101
platinum_sdk::live_assets::LiveAssetHandle::begin_edit
pub fn begin_edit(&self, view: &str) -> Result<AssetDraft, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:116
platinum_sdk::live_assets::LiveAssetHandle::stage
pub fn stage(
&self,
draft: AssetDraft,
expected_preview: Option<u64>,
) -> Result<u64, AssetEditFailure>
Publishes a clearly speculative shared preview and queues validation/CAS.
The source widget retains its typed draft on any failure.
Source: crates/platinum-sdk/src/live_assets.rs:129
platinum_sdk::live_assets::LiveAssetHandle::take_failure
pub fn take_failure(&self, view: &str) -> Option<AssetEditFailure>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:178
platinum_sdk::live_assets::LiveAssetHandle::discard_preview
pub fn discard_preview(&self, view: &str, generation: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:181
platinum_sdk::live_assets::LiveAssetHandle::flush
pub fn flush(&self) -> Result<bool, String>
Backend/update-lane only. No widget repaint should invoke a port or validator.
Source: crates/platinum-sdk/src/live_assets.rs:204
platinum_sdk::live_assets::LiveAssetHandle::reconcile_pending
pub fn reconcile_pending(&self) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:319
platinum_sdk::live_assets::LiveAssetHandle::accept
pub fn accept(&self, commit: &Commit) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:368
platinum_sdk::live_assets::LiveAssetHandle::refresh
pub fn refresh(&self) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:397
platinum_sdk::live_assets::LiveAssetRegistry
pub struct LiveAssetRegistry
Registry owns read projections/view leases, not canonical asset data. The
underlying port's LiveAuthority remains the only accepted-state writer.
Source: crates/platinum-sdk/src/live_assets.rs:486
platinum_sdk::live_assets::LiveAssetRegistry::new
pub fn new(max_assets: usize) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:497
platinum_sdk::live_assets::LiveAssetRegistry::get
pub fn get(&self, key: &AssetKey) -> Option<LiveAssetHandle>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:504
platinum_sdk::live_assets::LiveAssetRegistry::attach
pub fn attach(
&mut self,
binding: AssetBinding,
port: Arc<dyn AssetAuthorityPort>,
validator: AssetValidator,
) -> Result<LiveAssetHandle, String>
Trusted host attachment with an already authorized endpoint. Reusing a key
for a different document/generation is rejected, never retargeted silently.
Source: crates/platinum-sdk/src/live_assets.rs:509
platinum_sdk::live_assets::LiveAssetRegistry::handles
pub fn handles(&self) -> impl Iterator<Item
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:584
platinum_sdk::live_assets::EmbeddedAssetPort
pub struct EmbeddedAssetPort
Explicit volatile trusted-embedded adapter. It wraps the actual SDK authority
and an opaque authenticated connection; no private store/protocol is introduced.
Source: crates/platinum-sdk/src/live_assets.rs:591
platinum_sdk::live_assets::EmbeddedAssetPort::from_trusted_connection
pub fn from_trusted_connection(
authority: Arc<Mutex<crate::live::authority::LiveAuthority>>,
connection: crate::live::authority::Connection,
field: String,
validator: AssetValidator,
clock: Arc<dyn Fn() -> u64 + Send + Sync>,
) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_assets.rs:599
platinum_sdk::live_view_ui
platinum_sdk::live_view_ui
Concrete common JSON-model LiveView widget. It follows accepted model
revisions, keeps explicit drafts, and commits through the same authorized
schema/revision path used by Lua. Domain-specific renderers can use the same
attachment without introducing their own copy/storage authority.
Source: crates/platinum-sdk/src/live_view_ui.rs:1
platinum_sdk::live_view_ui::LiveJsonView
pub struct LiveJsonView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_view_ui.rs:11
platinum_sdk::live_view_ui::LiveJsonView::attach
pub fn attach(
handle: &LiveViewHandle,
definition: &LiveViewDefinition,
) -> Result<Self, LiveViewError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_view_ui.rs:19
platinum_sdk::live_view_ui::LiveJsonView::from_element
pub fn from_element(
handle: &LiveViewHandle,
element: &platinum_core::ui_document::UiElement,
) -> Result<Self, LiveViewError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_view_ui.rs:32
platinum_sdk::live_view_ui::LiveJsonView::show
pub fn show(&mut self, ui: &mut egui::Ui)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/live_view_ui.rs:38
platinum_sdk::live_view_ui::copy_from_definition
pub fn copy_from_definition(
handle: &LiveViewHandle,
definition: &LiveViewDefinition,
destination: Option<&platinum_core::live_view::files::LiveCopyDirectory>,
adjacent: Option<&platinum_core::live_view::files::LiveSourceFileLocation>,
preferred_name: &str,
) -> Result<platinum_core::live_view::files::LiveCopyReceipt, LiveViewError>
Complete the permanent-copy mode of the same GUI definition using a host-
resolved directory or actual source location. Authored aliases/path strings
themselves never authorize filesystem access.
Source: crates/platinum-sdk/src/live_view_ui.rs:125
platinum_sdk::lua_api
platinum_sdk::lua_api
Public Lua declarations and version-bound language assistance.
These declarations contain no binding implementation and never execute project code.
Source: crates/platinum-sdk/src/lua_api.rs:1
platinum_sdk::lua_api::LUA_API_SCHEMA_VERSION
pub const LUA_API_SCHEMA_VERSION: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:12
platinum_sdk::lua_api::LuaType
pub enum LuaType
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:16
platinum_sdk::lua_api::LuaType::display
pub fn display(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:33
platinum_sdk::lua_api::LuaType::annotation
pub fn annotation(text: &str) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:49
platinum_sdk::lua_api::Parameter
pub struct Parameter
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| ty | LuaType | |
| optional | bool | |
| variadic | bool | |
| default | Option<String> | |
| documentation | String | |
Source: crates/platinum-sdk/src/lua_api.rs:75
platinum_sdk::lua_api::Signature
pub struct Signature
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| parameters | Vec<Parameter> | |
| returns | Vec<LuaType> | |
| documentation | String | |
Source: crates/platinum-sdk/src/lua_api.rs:89
platinum_sdk::lua_api::SymbolKind
pub enum SymbolKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:100
platinum_sdk::lua_api::Availability
pub struct Availability
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| targets | BTreeSet<String> | Empty means every target supported by this module. |
| capabilities | BTreeSet<String> | |
| since | Option<String> | |
| deprecated | Option<String> | |
Source: crates/platinum-sdk/src/lua_api.rs:113
platinum_sdk::lua_api::ApiSymbol
pub struct ApiSymbol
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | Stable public declaration identity, independent of display names. |
| name | String | Qualified declaration, e.g. engine.spawn or Player.health. |
| module | String | |
| kind | SymbolKind | |
| ty | LuaType | |
| signatures | Vec<Signature> | |
| documentation | String | |
| examples | Vec<String> | |
| availability | Availability | |
| event_label | Option<String> | Human-readable sentence for Event Table integration. |
Source: crates/platinum-sdk/src/lua_api.rs:126
platinum_sdk::lua_api::ApiModule
pub struct ApiModule
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| version | String | |
| documentation | String | |
Source: crates/platinum-sdk/src/lua_api.rs:149
platinum_sdk::lua_api::ApiCatalog
pub struct ApiCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| schema_version | u32 | |
| revision | u64 | |
| modules | Vec<ApiModule> | |
| symbols | Vec<ApiSymbol> | |
Source: crates/platinum-sdk/src/lua_api.rs:157
platinum_sdk::lua_api::ApiEnvironment
pub struct ApiEnvironment
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| target | String | |
| enabled_modules | BTreeSet<String> | |
| capabilities | BTreeSet<String> | |
Source: crates/platinum-sdk/src/lua_api.rs:176
platinum_sdk::lua_api::ApiEnvironment::allows
pub fn allows(&self, s: &ApiSymbol) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:183
platinum_sdk::lua_api::ApiCatalog::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:191
platinum_sdk::lua_api::ApiCatalog::merge
pub fn merge(&mut self, extension: &Self) -> Result<(), String>
Transactional: conflicts leave the receiver unchanged. Identical modules and
symbols can be supplied by several consumers without duplicating declarations.
Source: crates/platinum-sdk/src/lua_api.rs:243
platinum_sdk::lua_api::ApiCatalog::lookup
pub fn lookup(&self, name: &str) -> Option<&ApiSymbol>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:278
platinum_sdk::lua_api::ApiCatalog::index
pub fn index(&self) -> BTreeMap<&str, &ApiSymbol>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:281
platinum_sdk::lua_api::LuaSandboxProfile
pub struct LuaSandboxProfile
Explicitly describes libraries installed by the host. There is deliberately no
default os/io/package/debug/load/dofile API: a host must publish its own grants.
Public data fields| Name | Type / declaration | Description |
|---|
| base | bool | |
| math | bool | |
| string | bool | |
| table | bool | |
| utf8 | bool | |
| coroutine | bool | |
Source: crates/platinum-sdk/src/lua_api.rs:289
platinum_sdk::lua_api::lua54_catalog
pub fn lua54_catalog(profile: &LuaSandboxProfile) -> ApiCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api.rs:298
platinum_sdk::lua_api::LanguageCancellation
pub struct LanguageCancellation(Arc<AtomicBool>)
Cooperative cancellation of obsolete worker jobs. Cancellation never publishes
a partially parsed replacement index.
Source: crates/platinum-sdk/src/lua_api/language.rs:10
platinum_sdk::lua_api::LanguageCancellation::cancel
pub fn cancel(&self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:12
platinum_sdk::lua_api::LanguageCancellation::is_cancelled
pub fn is_cancelled(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:15
platinum_sdk::lua_api::TextSpan
pub struct TextSpan
UTF-8 byte range in the exact document revision supplied with a result.
Public data fields| Name | Type / declaration | Description |
|---|
| start | usize | |
| end | usize | |
Source: crates/platinum-sdk/src/lua_api/language.rs:29
platinum_sdk::lua_api::Versioned
pub struct Versioned<T>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| uri | String | |
| revision | u64 | |
| catalog_revision | u64 | |
| project_revision | u64 | |
| value | T | |
Source: crates/platinum-sdk/src/lua_api/language.rs:40
platinum_sdk::lua_api::Location
pub struct Location
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| uri | String | |
| revision | u64 | |
| span | TextSpan | |
Source: crates/platinum-sdk/src/lua_api/language.rs:48
platinum_sdk::lua_api::Completion
pub struct Completion
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| label | String | |
| insert_text | String | |
| replace | TextSpan | |
| detail | String | |
| documentation | String | |
| symbol_id | Option<String> | |
Source: crates/platinum-sdk/src/lua_api/language.rs:54
platinum_sdk::lua_api::SignatureHelp
pub struct SignatureHelp
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| signatures | Vec<Signature> | |
| active_parameter | usize | |
Source: crates/platinum-sdk/src/lua_api/language.rs:63
platinum_sdk::lua_api::Hover
pub struct Hover
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| span | TextSpan | |
| name | String | |
| ty | LuaType | |
| documentation | String | |
| signatures | Vec<Signature> | |
Source: crates/platinum-sdk/src/lua_api/language.rs:69
platinum_sdk::lua_api::DiagnosticSeverity
pub enum DiagnosticSeverity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:78
platinum_sdk::lua_api::Diagnostic
pub struct Diagnostic
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| span | TextSpan | |
| severity | DiagnosticSeverity | |
| code | String | |
| message | String | |
Source: crates/platinum-sdk/src/lua_api/language.rs:84
platinum_sdk::lua_api::DocumentSymbol
pub struct DocumentSymbol
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| span | TextSpan | |
| ty | LuaType | |
| local | bool | |
Source: crates/platinum-sdk/src/lua_api/language.rs:91
platinum_sdk::lua_api::SyntaxKind
pub enum SyntaxKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:99
platinum_sdk::lua_api::SyntaxSpan
pub struct SyntaxSpan
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| span | TextSpan | |
| kind | SyntaxKind | |
Source: crates/platinum-sdk/src/lua_api/language.rs:108
platinum_sdk::lua_api::LuaLanguageService
pub struct LuaLanguageService
Shared per-project index. Only changed document revisions are tokenized again.
Catalog and environment updates invalidate requests through catalog_revision.
Parsing is bounded and lexical: arbitrary dynamic Lua remains Unknown.
Source: crates/platinum-sdk/src/lua_api/language.rs:148
platinum_sdk::lua_api::LuaLanguageService::new
pub fn new(catalog: ApiCatalog, environment: ApiEnvironment) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:158
platinum_sdk::lua_api::LuaLanguageService::catalog
pub fn catalog(&self) -> &ApiCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:169
platinum_sdk::lua_api::LuaLanguageService::parse_count
pub fn parse_count(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:172
platinum_sdk::lua_api::LuaLanguageService::set_catalog
pub fn set_catalog(
&mut self,
catalog: ApiCatalog,
environment: ApiEnvironment,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:175
platinum_sdk::lua_api::LuaLanguageService::set_module
pub fn set_module(&mut self, module: String, uri: String)
The caller provides authorized project-module names; no filesystem lookup or
require execution occurs here. One name maps to one document.
Source: crates/platinum-sdk/src/lua_api/language.rs:188
platinum_sdk::lua_api::LuaLanguageService::remove_document
pub fn remove_document(&mut self, uri: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:192
platinum_sdk::lua_api::LuaLanguageService::update_document
pub fn update_document(
&mut self,
uri: &str,
revision: u64,
text: &str,
) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:197
platinum_sdk::lua_api::LuaLanguageService::update_document_cancellable
pub fn update_document_cancellable(
&mut self,
uri: &str,
revision: u64,
text: &str,
cancellation: &LanguageCancellation,
) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:205
platinum_sdk::lua_api::LuaLanguageService::project_revision
pub fn project_revision(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:241
platinum_sdk::lua_api::LuaLanguageService::is_current
pub fn is_current<T>(&self, result: &Versioned<T>) -> bool
Reject asynchronous responses invalidated by a dependency or sandbox change,
even when the requesting document's text revision is unchanged.
Source: crates/platinum-sdk/src/lua_api/language.rs:246
platinum_sdk::lua_api::LuaLanguageService::syntax
pub fn syntax(&self, uri: &str, revision: u64) -> Result<Versioned<Vec<SyntaxSpan>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:313
platinum_sdk::lua_api::LuaLanguageService::diagnostics
pub fn diagnostics(
&self,
uri: &str,
revision: u64,
) -> Result<Versioned<Vec<Diagnostic>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:316
platinum_sdk::lua_api::LuaLanguageService::outline
pub fn outline(
&self,
uri: &str,
revision: u64,
) -> Result<Versioned<Vec<DocumentSymbol>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:339
platinum_sdk::lua_api::LuaLanguageService::completions
pub fn completions(
&self,
uri: &str,
revision: u64,
offset: usize,
) -> Result<Versioned<Vec<Completion>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:359
platinum_sdk::lua_api::LuaLanguageService::hover
pub fn hover(
&self,
uri: &str,
revision: u64,
offset: usize,
) -> Result<Versioned<Option<Hover>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:500
platinum_sdk::lua_api::LuaLanguageService::signature_help
pub fn signature_help(
&self,
uri: &str,
revision: u64,
offset: usize,
) -> Result<Versioned<Option<SignatureHelp>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:532
platinum_sdk::lua_api::LuaLanguageService::definition
pub fn definition(
&self,
uri: &str,
revision: u64,
offset: usize,
) -> Result<Versioned<Option<Location>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/language.rs:579
platinum_sdk::lua_api::LuaLanguageService::references
pub fn references(
&self,
uri: &str,
revision: u64,
offset: usize,
) -> Result<Versioned<Vec<Location>>, String>
Only lexically resolved references are returned, never a whole-project text guess.
Source: crates/platinum-sdk/src/lua_api/language.rs:595
platinum_sdk::lua_api::LanguageQuery
pub enum LanguageQuery
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:7
platinum_sdk::lua_api::LanguageWorkerCommand
pub enum LanguageWorkerCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:14
platinum_sdk::lua_api::LanguageEnvironment
pub struct LanguageEnvironment
Serializable transport form; granted APIs remain host-selected.
Public data fields| Name | Type / declaration | Description |
|---|
| target | String | |
| enabled_modules | std::collections::BTreeSet<String> | |
| capabilities | std::collections::BTreeSet<String> | |
Source: crates/platinum-sdk/src/lua_api/worker.rs:40
platinum_sdk::lua_api::LanguageAssistance
pub struct LanguageAssistance
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| syntax | Vec<SyntaxSpan> | |
| diagnostics | Vec<Diagnostic> | |
| completions | Vec<Completion> | |
| signature | Option<SignatureHelp> | |
| hover | Option<Hover> | |
| outline | Vec<DocumentSymbol> | |
Source: crates/platinum-sdk/src/lua_api/worker.rs:65
platinum_sdk::lua_api::LanguageWorkerResponse
pub enum LanguageWorkerResponse
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:74
platinum_sdk::lua_api::LanguageWorkerFailure
pub struct LanguageWorkerFailure
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| message | String | |
Source: crates/platinum-sdk/src/lua_api/worker.rs:91
platinum_sdk::lua_api::LanguageWorkerReport
pub struct LanguageWorkerReport
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| request_id | Option<u64> | |
| project_revision | u64 | |
| outcome | Result<LanguageWorkerResponse, LanguageWorkerFailure> | |
Source: crates/platinum-sdk/src/lua_api/worker.rs:95
platinum_sdk::lua_api::LanguageWorkerLimits
pub struct LanguageWorkerLimits
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| queued_commands | usize | |
| retained_reports | usize | |
| max_documents | usize | |
| max_project_bytes | usize | |
| max_modules | usize | |
Source: crates/platinum-sdk/src/lua_api/worker.rs:101
platinum_sdk::lua_api::LanguageSubmitError
pub enum LanguageSubmitError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:135
platinum_sdk::lua_api::CooperativeLanguageWorker
pub struct CooperativeLanguageWorker
WASM cooperative scheduler and deterministic worker test facade. Pump from an
idle/task callback, never from widget repaint. A single document parse is one
bounded work item; large-browser projects should put this facade in a Web Worker.
Source: crates/platinum-sdk/src/lua_api/worker.rs:308
platinum_sdk::lua_api::CooperativeLanguageWorker::new
pub fn new(
catalog: ApiCatalog,
environment: ApiEnvironment,
limits: LanguageWorkerLimits,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:315
platinum_sdk::lua_api::CooperativeLanguageWorker::enqueue
pub fn enqueue(&mut self, command: LanguageWorkerCommand) -> Result<(), LanguageSubmitError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:327
platinum_sdk::lua_api::CooperativeLanguageWorker::pending_commands
pub fn pending_commands(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:354
platinum_sdk::lua_api::CooperativeLanguageWorker::dropped_reports
pub fn dropped_reports(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:357
platinum_sdk::lua_api::CooperativeLanguageWorker::pump
pub fn pump(&mut self, max_commands: usize) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:360
platinum_sdk::lua_api::CooperativeLanguageWorker::poll_report
pub fn poll_report(&mut self) -> Option<LanguageWorkerReport>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/lua_api/worker.rs:376
platinum_sdk::application_package
platinum_sdk::application_package
Compatibility import path for the renderer-free application package crate.
Launchers and release verification tools should depend on that crate directly
so code/package verification does not initialize or link the SDK renderer.
Source: crates/platinum-sdk/src/application_package.rs:1
platinum_sdk::formats
platinum_sdk::formats
Bounded OpenDocument and Markdown interchange. No network fetches or filesystem extraction.
Source: crates/platinum-sdk/src/formats.rs:1
platinum_sdk::formats::MAX_PACKAGE_BYTES
pub const MAX_PACKAGE_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:5
platinum_sdk::formats::ImportedDocument
pub struct ImportedDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| document | RichDocument | |
| warnings | Vec<String> | |
Source: crates/platinum-sdk/src/formats.rs:6
platinum_sdk::formats::decode_document
pub fn decode_document(name: &str, bytes: &[u8]) -> Result<ImportedDocument, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:10
platinum_sdk::formats::write_odt
pub fn write_odt(d: &RichDocument) -> Result<Vec<u8>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:118
platinum_sdk::formats::read_odt
pub fn read_odt(bytes: &[u8]) -> Result<ImportedDocument, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:363
platinum_sdk::formats::read_markdown
pub fn read_markdown(text: &str) -> Result<ImportedDocument, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:725
platinum_sdk::formats::read_markdown_with_assets
pub fn read_markdown_with_assets(
text: &str,
mut load: impl FnMut(&str) -> Option<Vec<u8>>,
) -> Result<ImportedDocument, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:728
platinum_sdk::formats::write_markdown
pub fn write_markdown(d: &RichDocument) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:942
platinum_sdk::formats::write_html
pub fn write_html(d: &RichDocument) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:1061
platinum_sdk::formats::safe_link
pub fn safe_link(url: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/formats.rs:1386
platinum_sdk::formats::decode_document_with_assets
pub fn decode_document_with_assets(
name: &str,
bytes: &[u8],
folder: Option<&std::path::Path>,
) -> Result<crate::formats::ImportedDocument, String>
Decode a document and resolve local Markdown pictures beneath its source folder.
Source: crates/platinum-sdk/src/formats.rs:1396
platinum_sdk::editor
platinum_sdk::editor
Embeddable document editing state, standard commands and reusable Office controls.
Source: crates/platinum-sdk/src/editor.rs:1
platinum_sdk::editor::DocumentEditor
pub struct DocumentEditor
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state_ready | bool | Authoritative startup restore completed; hosts disable editing while false. |
| saved_baseline_unknown | bool | A recovered document has no durable saved-baseline snapshot in v1. |
| doc | Tracked<RichDocument> | |
| saved | RichDocument | |
| name | String | |
| editor | RichEditorState | |
| history | DocumentHistory | |
| zoom | f32 | |
| page_view | office::PageViewState | |
| ruler | bool | |
| find_open | bool | |
| find | String | |
| replacement | String | |
| notice | String | |
| last_edit | f64 | |
| revision | u64 | |
Source: crates/platinum-sdk/src/editor.rs:19
platinum_sdk::editor::DocumentEditor::new
pub fn new(doc: RichDocument, name: String) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:52
platinum_sdk::editor::DocumentEditor::dirty
pub fn dirty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:87
platinum_sdk::editor::DocumentEditor::mark_saved
pub fn mark_saved(&mut self, saved: RichDocument)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:90
platinum_sdk::editor::DocumentEditor::record
pub fn record(&mut self, before: RichDocument, time: f64, typing: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:94
platinum_sdk::editor::DocumentEditor::attach_text_source
pub fn attach_text_source(&mut self, source: SharedTextDocument) -> Result<(), String>
Bind a sibling view to the same canonical text. Rich formatting remains
this view's persistence projection in v1; this does not share metadata.
Source: crates/platinum-sdk/src/editor.rs:171
platinum_sdk::editor::DocumentEditor::text_source
pub fn text_source(&self) -> Option<SharedTextDocument>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:188
platinum_sdk::editor::DocumentEditor::text_conflicted
pub fn text_conflicted(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:191
platinum_sdk::editor::DocumentEditor::pump_text
pub fn pump_text(&mut self) -> Result<bool, String>
Host update only. Paint records a draft; it never dispatches authority
commands. False defers persistence while IME/pending input is unresolved.
Source: crates/platinum-sdk/src/editor.rs:196
platinum_sdk::editor::DocumentEditor::observe_restored_projection
pub fn observe_restored_projection(&mut self)
Call after StateSync adopts a newer persistence projection. An external
text replacement is an explicit import conflict, never another canonical
text mutation authority. Formatting-only refreshes remain compatible.
Source: crates/platinum-sdk/src/editor.rs:326
platinum_sdk::editor::DocumentEditor::text_ready_to_save
pub fn text_ready_to_save(&mut self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:341
platinum_sdk::editor::EditorCommand
pub enum EditorCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:376
platinum_sdk::editor::default_menus
pub fn default_menus() -> office::MenuHost
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:407
platinum_sdk::editor::command_from_id
pub fn command_from_id(id: &str) -> Option<EditorCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:474
platinum_sdk::editor::shortcuts
pub fn shortcuts(ctx: &egui::Context, actions: &mut Vec<EditorCommand>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:506
platinum_sdk::editor::standard_toolbar
pub fn standard_toolbar(ui: &mut egui::Ui, d: &mut DocumentEditor) -> Vec<EditorCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:540
platinum_sdk::editor::DocumentEditor::insert_text
pub fn insert_text(&mut self, text: &str, time: f64) -> bool
Replace the Unicode-character selection and return focus to the editable page.
Source: crates/platinum-sdk/src/editor.rs:601
platinum_sdk::editor::DocumentEditor::focus_selection
pub fn focus_selection(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:618
platinum_sdk::editor::DocumentEditor::find_next
pub fn find_next(&mut self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:622
platinum_sdk::editor::DocumentEditor::replace_all
pub fn replace_all(&mut self, time: f64) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:646
platinum_sdk::editor::DocumentEditor::execute
pub fn execute(&mut self, command: EditorCommand, time: f64) -> bool
Handle document-only commands. False means the embedding host must handle the command.
Source: crates/platinum-sdk/src/editor.rs:674
platinum_sdk::editor::find_bar
pub fn find_bar(ui: &mut egui::Ui, d: &mut DocumentEditor, time: f64)
Find/replace controls that operate on global Unicode selections, including paged editors.
Source: crates/platinum-sdk/src/editor.rs:796
platinum_sdk::editor::status_bar
pub fn status_bar(ui: &mut egui::Ui, d: &DocumentEditor)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/editor.rs:813
platinum_sdk::editor::document_view
pub fn document_view(ui: &mut egui::Ui, id: egui::Id, d: &mut DocumentEditor, time: f64)
The themed, scrollable page view. Records edits in the shared undo history.
Source: crates/platinum-sdk/src/editor.rs:831
platinum_sdk::editor::formatting_palette
pub fn formatting_palette(ui: &mut egui::Ui, d: &mut DocumentEditor, time: f64)
An embeddable formatting palette with undo/history integration.
Source: crates/platinum-sdk/src/editor.rs:884
platinum_sdk::editor::menu_bar
pub fn menu_bar(ui: &mut egui::Ui, menus: &office::MenuHost) -> Vec<CommandId>
Standard menus return command identifiers; the host decides how to dispatch them.
Source: crates/platinum-sdk/src/editor.rs:895
platinum_sdk::file_manager
platinum_sdk::file_manager
Spatial file objects and content exchange. No host filesystem access is implicit.
Hosts own durable storage, application launching and native drag/clipboard adapters.
Source: crates/platinum-sdk/src/file_manager.rs:1
platinum_sdk::file_manager::FileId
pub struct FileId(pub u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:20
platinum_sdk::file_manager::DESKTOP
pub const DESKTOP: FileId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:21
platinum_sdk::file_manager::TRASH
pub const TRASH: FileId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:22
platinum_sdk::file_manager::MAX_FILE_BYTES
pub const MAX_FILE_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:23
platinum_sdk::file_manager::MAX_VOLUME_BYTES
pub const MAX_VOLUME_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:24
platinum_sdk::file_manager::FileKind
pub enum FileKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:27
platinum_sdk::file_manager::FileObject
pub struct FileObject
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | FileId | |
| parent | Option<FileId> | |
| name | String | |
| kind | FileKind | |
| locked | bool | |
| label | u8 | |
| comment | String | |
| original_parent | Option<FileId> | Original container for Put Away, retained while an item is in Trash. |
Source: crates/platinum-sdk/src/file_manager.rs:34
platinum_sdk::file_manager::FileContent
pub struct FileContent
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| mime | String | |
| bytes | Arc<[u8]> | |
Source: crates/platinum-sdk/src/file_manager.rs:46
platinum_sdk::file_manager::FileContent::text
pub fn text(text: &str) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:52
platinum_sdk::file_manager::FileContent::document
pub fn document(document: &RichDocument) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:59
platinum_sdk::file_manager::Transfer
pub enum Transfer
Same payload is used for SDK drags and clipboard exchange.
Source: crates/platinum-sdk/src/file_manager.rs:69
platinum_sdk::file_manager::DropIntent
pub enum DropIntent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:74
platinum_sdk::file_manager::FileManager
pub struct FileManager
Indexed, bounded proof-of-concept volume. Byte buffers are shared across undo states.
Public data fields| Name | Type / declaration | Description |
|---|
| revision | u64 | |
Source: crates/platinum-sdk/src/file_manager.rs:84
platinum_sdk::file_manager::FileManager::get
pub fn get(&self, id: FileId) -> Result<&FileObject, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:124
platinum_sdk::file_manager::FileManager::children
pub fn children(&self, folder: FileId) -> Vec<FileId>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:130
platinum_sdk::file_manager::FileManager::resolve
pub fn resolve(&self, mut id: FileId) -> Result<FileId, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:137
platinum_sdk::file_manager::FileManager::undo
pub fn undo(&mut self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:157
platinum_sdk::file_manager::FileManager::redo
pub fn redo(&mut self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:165
platinum_sdk::file_manager::FileManager::unique_name
pub fn unique_name(&self, parent: FileId, preferred: &str) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:195
platinum_sdk::file_manager::FileManager::create
pub fn create(&mut self, parent: FileId, name: &str, kind: FileKind) -> Result<FileId, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:211
platinum_sdk::file_manager::FileManager::receive
pub fn receive(&mut self, folder: FileId, content: &FileContent) -> Result<FileId, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:258
platinum_sdk::file_manager::FileManager::content
pub fn content(&self, id: FileId) -> Result<FileContent, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:269
platinum_sdk::file_manager::FileManager::copy_files
pub fn copy_files(&mut self, ids: &[FileId], destination: FileId) -> Result<(), String>
Copy regular file content. Containers require the future recursive storage backend.
Source: crates/platinum-sdk/src/file_manager.rs:281
platinum_sdk::file_manager::FileManager::rename
pub fn rename(&mut self, id: FileId, name: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:333
platinum_sdk::file_manager::FileManager::set_metadata
pub fn set_metadata(
&mut self,
id: FileId,
locked: bool,
label: u8,
comment: String,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:344
platinum_sdk::file_manager::FileManager::move_objects
pub fn move_objects(&mut self, ids: &[FileId], destination: FileId) -> Result<(), String>
All validation precedes mutation; a multi-object move is one undoable transaction.
Source: crates/platinum-sdk/src/file_manager.rs:363
platinum_sdk::file_manager::FileManager::put_away
pub fn put_away(&mut self, id: FileId) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:424
platinum_sdk::file_manager::FileManager::drop_intent
pub fn drop_intent(&self, target: FileId, transfer: &Transfer) -> Result<DropIntent, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:436
platinum_sdk::file_manager::insert_content
pub fn insert_content(
editor: &mut DocumentEditor,
content: &FileContent,
time: f64,
) -> Result<(), String>
Apply file content through the same editor history used by typing and Undo.
Source: crates/platinum-sdk/src/file_manager.rs:473
platinum_sdk::file_manager::insert_rich_content
pub fn insert_rich_content(
editor: &mut DocumentEditor,
incoming: &RichDocument,
time: f64,
) -> Result<(), String>
Insert a rich object at the Unicode selection, preserving its styles and anchored objects.
Destination page geometry remains in force. Failed validation restores the entire document.
Source: crates/platinum-sdk/src/file_manager.rs:518
platinum_sdk::file_manager::selected_text
pub fn selected_text(editor: &DocumentEditor) -> Option<FileContent>
Export selection as an ordinary UTF-8 file, without interpreting Unicode indices as bytes.
Source: crates/platinum-sdk/src/file_manager.rs:564
platinum_sdk::file_manager::WindowGroups
pub struct WindowGroups
Geometry shared by folder and document windows. Alt-drag detaches one member.
Public data fields| Name | Type / declaration | Description |
|---|
| rectangles | BTreeMap<u64, egui::Rect> | |
Source: crates/platinum-sdk/src/file_manager.rs:582
platinum_sdk::file_manager::WindowGroups::members
pub fn members(&self, id: u64) -> BTreeSet<u64>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:587
platinum_sdk::file_manager::WindowGroups::detach
pub fn detach(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:602
platinum_sdk::file_manager::WindowGroups::remove
pub fn remove(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:605
platinum_sdk::file_manager::WindowGroups::translate
pub fn translate(&mut self, id: u64, delta: egui::Vec2, separate: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:609
platinum_sdk::file_manager::WindowGroups::snap
pub fn snap(&mut self, id: u64, threshold: f32) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager.rs:619
platinum_sdk::file_manager::filesystem
platinum_sdk::file_manager::filesystem
Asynchronous real filesystem provider. Content stays on disk; listings contain metadata only.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:1
platinum_sdk::file_manager::filesystem::Entry
pub struct Entry
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | PathBuf | |
| name | String | |
| directory | bool | |
| symlink | bool | |
| bytes | u64 | |
| modified | u64 | |
| readonly | bool | |
| hidden | bool | |
| name_key | String | |
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:18
platinum_sdk::file_manager::filesystem::Entry::kind
pub fn kind(&self) -> &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:30
platinum_sdk::file_manager::filesystem::mime
pub fn mime(path: &Path) -> &'static str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:55
platinum_sdk::file_manager::filesystem::Request
pub enum Request
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:77
platinum_sdk::file_manager::filesystem::Reply
pub enum Reply
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:101
platinum_sdk::file_manager::filesystem::DecodedFile
pub struct DecodedFile
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | PathBuf | |
| name | String | |
| image | bool | |
| document | crate::rich_text::RichDocument | |
| warnings | Vec<String> | |
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:115
platinum_sdk::file_manager::filesystem::Completed
pub struct Completed
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| result | Result<Reply, String> | |
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:122
platinum_sdk::file_manager::filesystem::FilesystemService
pub struct FilesystemService
One worker owns filesystem jobs; no directory walking or file decoding occurs in draw systems.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:133
platinum_sdk::file_manager::filesystem::FilesystemService::submit
pub fn submit(&self, request: Request) -> (u64, Arc<AtomicBool>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:161
platinum_sdk::file_manager::filesystem::FilesystemService::drain
pub fn drain(&self) -> Vec<Completed>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:171
platinum_sdk::file_manager::filesystem::validate_name
pub fn validate_name(name: &str) -> std::io::Result<()>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:185
platinum_sdk::file_manager::filesystem::unique_path
pub fn unique_path(folder: &Path, preferred: &str) -> PathBuf
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:206
platinum_sdk::file_manager::filesystem::trash_directory
pub fn trash_directory(folder: &Path) -> PathBuf
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:545
platinum_sdk::file_manager::filesystem::execute
pub fn execute(request: Request, cancel: &AtomicBool) -> std::io::Result<Reply>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/filesystem.rs:594
platinum_sdk::file_manager::native
platinum_sdk::file_manager::native
Persistent native Finder-style folder windows, shared by Files and Write applications.
Source: crates/platinum-sdk/src/file_manager/native.rs:1
platinum_sdk::file_manager::native::FilesConfig
pub struct FilesConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state_tracking | bool | |
| state_application | String | |
| initial_path | Option<PathBuf> | |
| primary_folder | bool | |
| restore | bool | |
| state_path | PathBuf | |
Source: crates/platinum-sdk/src/file_manager/native.rs:35
platinum_sdk::file_manager::native::home_directory
pub fn home_directory() -> PathBuf
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:55
platinum_sdk::file_manager::native::session_path
pub fn session_path() -> PathBuf
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:61
platinum_sdk::file_manager::native::ViewMode
pub enum ViewMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:75
platinum_sdk::file_manager::native::SortColumn
pub enum SortColumn
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:81
platinum_sdk::file_manager::native::FolderPreferences
pub struct FolderPreferences
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state_root | String | |
| path | PathBuf | |
| position | [i32; 2] | |
| size | [u32; 2] | |
| mode | ViewMode | |
| sort | SortColumn | |
| descending | bool | |
| expanded | BTreeSet<PathBuf> | |
| hidden | bool | |
| columns | [f32; 4] | |
| scroll | [f32; 2] | |
| icons | BTreeMap<String, [f32; 2]> | |
| snap_to_grid | bool | |
| toolbar | bool | |
Source: crates/platinum-sdk/src/file_manager/native.rs:90
platinum_sdk::file_manager::native::FolderSession
pub struct FolderSession
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| sync_close_requested | bool | |
| state_ready | bool | |
| window | Entity | |
| camera | Entity | |
| prefs | Tracked<FolderPreferences> | |
| selection | BTreeSet<PathBuf> | |
Source: crates/platinum-sdk/src/file_manager/native.rs:126
platinum_sdk::file_manager::native::FolderSession::set_view
pub fn set_view(&mut self, view: ViewMode)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:178
platinum_sdk::file_manager::native::FileBrowser
pub struct FileBrowser
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| folders | Vec<FolderSession> | |
| notice | String | |
Source: crates/platinum-sdk/src/file_manager/native.rs:212
platinum_sdk::file_manager::native::NativeWindows
pub struct NativeWindows
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| groups | WindowGroups | |
Source: crates/platinum-sdk/src/file_manager/native.rs:235
platinum_sdk::file_manager::native::NativeWindows::begin_drag
pub fn begin_drag(&mut self, window: Entity, separate: bool)
Host adapters use these when their title tracking is outside egui.
Source: crates/platinum-sdk/src/file_manager/native.rs:243
platinum_sdk::file_manager::native::NativeWindows::finish_drag
pub fn finish_drag(&mut self, window: Entity)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:250
platinum_sdk::file_manager::native::NativeWindows::chrome
pub fn chrome(&mut self, window: Entity, action: office::ChromeAction, ctx: &egui::Context)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:254
platinum_sdk::file_manager::native::FilesSet
pub enum FilesSet
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:270
platinum_sdk::file_manager::native::NativeFileDrop
pub struct NativeFileDrop
Host-normalized drop event. Coordinates are egui points in the destination window.
Native OS drops are translated to this same routing path; embedders can supply their own adapter.
Public data fields| Name | Type / declaration | Description |
|---|
| window | Entity | |
| paths | Vec<PathBuf> | |
| point | Option<egui::Pos2> | |
Source: crates/platinum-sdk/src/file_manager/native.rs:280
platinum_sdk::file_manager::native::NativeFileManagerPlugin
pub struct NativeFileManagerPlugin(pub FilesConfig)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:285
platinum_sdk::file_manager::native::FileBrowser::open
pub fn open(
&mut self,
commands: &mut Commands,
service: &FilesystemService,
mut prefs: FolderPreferences,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native.rs:397
platinum_sdk::file_manager::native_drag
platinum_sdk::file_manager::native_drag
OS drag sessions. File paths cross process boundaries; snippets are staged off the UI thread.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:1
platinum_sdk::file_manager::native_drag::DragPayload
pub enum DragPayload
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:11
platinum_sdk::file_manager::native_drag::NativeDrag
pub struct NativeDrag
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| document_targets | std::collections::BTreeMap<Entity, crate::office::egui::Rect> | |
| last_paths | Vec<PathBuf> | |
| copy | bool | |
| notice | Option<String> | |
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:16
platinum_sdk::file_manager::native_drag::NativeDrag::begin
pub fn begin(&mut self, window: Entity, payload: DragPayload, copy: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:40
platinum_sdk::file_manager::native_drag::run
pub fn run(
mut drag: ResMut<NativeDrag>,
handles: Query<&RawHandleWrapper>,
mut released: MessageWriter<bevy::input::mouse::MouseButtonInput>,
_main_thread: NonSendMarker,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:45
platinum_sdk::file_manager::native_drag::copy_requested
pub fn copy_requested(default: bool) -> bool
Current cursor in physical desktop pixels, including during an OLE file drop.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:145
platinum_sdk::file_manager::native_drag::desktop_cursor
pub fn desktop_cursor() -> Option<IVec2>
Current cursor in physical desktop pixels, including during an OLE file drop.
Source: crates/platinum-sdk/src/file_manager/native_drag.rs:166
platinum_sdk::file_manager::native_preview
platinum_sdk::file_manager::native_preview
Bounded, asynchronous thumbnails and read-only native preview windows.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:1
platinum_sdk::file_manager::native_preview::FilePreviews
pub struct FilePreviews
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:43
platinum_sdk::file_manager::native_preview::FilePreviews::windows
pub fn windows(&self) -> impl Iterator<Item
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:74
platinum_sdk::file_manager::native_preview::FilePreviews::is_empty
pub fn is_empty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:77
platinum_sdk::file_manager::native_preview::FilePreviews::icon
pub fn icon(&mut self, ui: &egui::Ui, rect: egui::Rect, entry: &Entry)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:107
platinum_sdk::file_manager::native_preview::FilePreviews::open
pub fn open(&mut self, commands: &mut Commands, entry: Entry)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:165
platinum_sdk::file_manager::native_preview::draw
pub fn draw(
mut previews: ResMut<FilePreviews>,
mut contexts: Query<(&OfficeSurface, &mut EguiContext)>,
mut windows: Query<&mut Window>,
mut groups: ResMut<super::native::NativeWindows>,
mut close: MessageReader<WindowCloseRequested>,
mut commands: Commands,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/native_preview.rs:232
platinum_sdk::file_manager::view
platinum_sdk::file_manager::view
Composable folder windows. Intent events keep application launching and I/O host-owned.
Source: crates/platinum-sdk/src/file_manager/view.rs:1
platinum_sdk::file_manager::view::FolderView
pub enum FolderView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/view.rs:100
platinum_sdk::file_manager::view::FolderWindow
pub struct FolderWindow
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| folder | FileId | |
| mode | FolderView | |
| selection | BTreeSet<FileId> | |
Source: crates/platinum-sdk/src/file_manager/view.rs:105
platinum_sdk::file_manager::view::FileViewEvent
pub enum FileViewEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/view.rs:113
platinum_sdk::file_manager::view::FileManagerView
pub struct FileManagerView
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| windows | Vec<FolderWindow> | |
| groups | WindowGroups | |
| active | Option<FileId> | |
| notice | String | |
| clipboard | Option<Transfer> | |
| info | Option<FileId> | |
Source: crates/platinum-sdk/src/file_manager/view.rs:119
platinum_sdk::file_manager::view::spatial_window
pub fn spatial_window(
ctx: &egui::Context,
groups: &mut WindowGroups,
id: u64,
title: &str,
content: impl FnOnce(&mut egui::Ui),
) -> bool
Custom Platinum title strip and shared spatial movement for any SDK content.
Returns false when the close box is clicked. The host owns window lifetime.
Source: crates/platinum-sdk/src/file_manager/view.rs:129
platinum_sdk::file_manager::view::FileManagerView::open
pub fn open(&mut self, manager: &FileManager, folder: FileId) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/view.rs:195
platinum_sdk::file_manager::view::FileManagerView::show
pub fn show(&mut self, ctx: &egui::Context, manager: &mut FileManager) -> Vec<FileViewEvent>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/view.rs:221
platinum_sdk::file_manager::list_model
platinum_sdk::file_manager::list_model
Renderer-independent folder-list state and deferred, versioned events.
References identify entries within a host-provisioned listing; they grant no rights.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:1
platinum_sdk::file_manager::list_model::MAX_ENTRIES
pub const MAX_ENTRIES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:6
platinum_sdk::file_manager::list_model::MAX_EVENT_BYTES
pub const MAX_EVENT_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:7
platinum_sdk::file_manager::list_model::MAX_QUEUED_BYTES
pub const MAX_QUEUED_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:8
platinum_sdk::file_manager::list_model::MAX_QUEUED_EVENTS
pub const MAX_QUEUED_EVENTS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:9
platinum_sdk::file_manager::list_model::EntryKind
pub enum EntryKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:13
platinum_sdk::file_manager::list_model::EntryRole
pub enum EntryRole
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:19
platinum_sdk::file_manager::list_model::ListEntry
pub struct ListEntry
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| label | String | |
| kind | EntryKind | |
| writable | bool | |
| role | EntryRole | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:27
platinum_sdk::file_manager::list_model::EntryRef
pub struct EntryRef
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scope | String | |
| revision | String | |
| id | String | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:37
platinum_sdk::file_manager::list_model::ListCursor
pub struct ListCursor
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scope | String | |
| revision | String | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:44
platinum_sdk::file_manager::list_model::ListSnapshot
pub struct ListSnapshot
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scope | String | |
| revision | u64 | |
| entries | Vec<ListEntry> | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:49
platinum_sdk::file_manager::list_model::ListSnapshot::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:55
platinum_sdk::file_manager::list_model::SortOrder
pub enum SortOrder
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:75
platinum_sdk::file_manager::list_model::ListLayout
pub enum ListLayout
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:83
platinum_sdk::file_manager::list_model::ListColumn
pub enum ListColumn
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:93
platinum_sdk::file_manager::list_model::ViewPolicy
pub struct ViewPolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| writable | bool | |
| folders_as_targets | bool | |
| multiple | bool | |
| browse_only | bool | |
| allow_activation | bool | |
| show_hidden | bool | |
| show_internal | bool | |
| allowed_suffixes | Vec<String> | |
| sort | SortOrder | |
| layout | ListLayout | |
| columns | Vec<ListColumn> | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:100
platinum_sdk::file_manager::list_model::ViewPolicy::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:131
platinum_sdk::file_manager::list_model::ListEvent
pub enum ListEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:148
platinum_sdk::file_manager::list_model::MutationResult
pub enum MutationResult
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:175
platinum_sdk::file_manager::list_model::ListEventDto
pub struct ListEventDto
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u16 | |
| listing | ListCursor | |
| view | String | |
| subscription | Option<String> | |
| sequence | String | Canonical decimal string: Lua/JavaScript must not round an exact counter. |
| event | ListEvent | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:181
platinum_sdk::file_manager::list_model::ListEventDto::references
pub fn references(&self) -> Vec<&EntryRef>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:191
platinum_sdk::file_manager::list_model::ListEventDto::encode
pub fn encode(&self) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:229
platinum_sdk::file_manager::list_model::ListEventDto::decode
pub fn decode(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:236
platinum_sdk::file_manager::list_model::ListState
pub struct ListState
No filesystem access or callback invocation occurs here. The host dispatches
drained events on its logic lane after authorizing every referenced entry.
Public data fields| Name | Type / declaration | Description |
|---|
| selected | BTreeSet<String> | |
| search | String | |
| focused | Option<String> | |
| error | Option<String> | |
Source: crates/platinum-sdk/src/file_manager/list_model.rs:271
platinum_sdk::file_manager::list_model::ListState::bind
pub fn bind(&mut self, view: String, subscription: Option<String>) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:328
platinum_sdk::file_manager::list_model::ListState::identity
pub fn identity(&self) -> (&str, Option<&str>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:345
platinum_sdk::file_manager::list_model::ListState::snapshot
pub fn snapshot(&self) -> Option<&ListSnapshot>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:348
platinum_sdk::file_manager::list_model::ListState::policy
pub fn policy(&self) -> &ViewPolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:351
platinum_sdk::file_manager::list_model::ListState::replace
pub fn replace(&mut self, snapshot: ListSnapshot) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:354
platinum_sdk::file_manager::list_model::ListState::configure
pub fn configure(&mut self, policy: ViewPolicy) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:421
platinum_sdk::file_manager::list_model::ListState::visible_indices
pub fn visible_indices(&mut self) -> &[usize]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:439
platinum_sdk::file_manager::list_model::ListState::visible_entry
pub fn visible_entry(&self, visible_index: usize) -> Option<&ListEntry>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:443
platinum_sdk::file_manager::list_model::ListState::sort_rebuilds
pub fn sort_rebuilds(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:449
platinum_sdk::file_manager::list_model::ListState::filter_rebuilds
pub fn filter_rebuilds(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:452
platinum_sdk::file_manager::list_model::ListState::reference
pub fn reference(&self, id: &str) -> Result<EntryRef, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:455
platinum_sdk::file_manager::list_model::ListState::validate_reference
pub fn validate_reference(&self, r: &EntryRef) -> Result<&ListEntry, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:466
platinum_sdk::file_manager::list_model::ListState::select
pub fn select(&mut self, id: &str, additive: bool, range: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:577
platinum_sdk::file_manager::list_model::ListState::clear_selection
pub fn clear_selection(&mut self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:618
platinum_sdk::file_manager::list_model::ListState::select_all
pub fn select_all(&mut self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:624
platinum_sdk::file_manager::list_model::ListState::activate
pub fn activate(&mut self, id: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:634
platinum_sdk::file_manager::list_model::ListState::choose_target
pub fn choose_target(&mut self, id: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:646
platinum_sdk::file_manager::list_model::ListState::context
pub fn context(&mut self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:657
platinum_sdk::file_manager::list_model::ListState::request_drop
pub fn request_drop(&mut self, items: Vec<EntryRef>, target: EntryRef) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:665
platinum_sdk::file_manager::list_model::ListState::mutation_completed
pub fn mutation_completed(
&mut self,
operation: String,
result: MutationResult,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:678
platinum_sdk::file_manager::list_model::ListState::move_focus
pub fn move_focus(&mut self, delta: isize, extend: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:688
platinum_sdk::file_manager::list_model::ListState::drain_events
pub fn drain_events(&mut self) -> Vec<ListEventDto>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:708
platinum_sdk::file_manager::list_model::ListState::validate_event
pub fn validate_event(&mut self, dto: &ListEventDto) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:712
platinum_sdk::file_manager::list_model::AuthorizedListEvent
pub struct AuthorizedListEvent<'a>
Call only on the host logic lane. Validate the complete event before
disclosure; one unauthorized reference suppresses the entire callback.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:759
platinum_sdk::file_manager::list_model::AuthorizedListEvent::dto
pub fn dto(&self) -> &ListEventDto
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:763
platinum_sdk::file_manager::list_model::dispatch_events
pub fn dispatch_events(
state: &mut ListState,
events: Vec<ListEventDto>,
mut authorize: impl FnMut(&ListEventDto) -> Result<(), String>,
mut sink: impl FnMut(&AuthorizedListEvent<'_>) -> Result<(), String>,
) -> Vec<String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_model.rs:767
platinum_sdk::file_manager::list
platinum_sdk::file_manager::list
The common Files/script/test list row. Filtering and selection are host owned;
security is enforced by the backing service, never by this presentation control.
Source: crates/platinum-sdk/src/file_manager/list.rs:1
platinum_sdk::file_manager::list::row
pub fn row(ui: &mut egui::Ui, label: &str, selected: bool, size: egui::Vec2) -> egui::Response
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list.rs:5
platinum_sdk::file_manager::list::allocate_row
pub fn allocate_row(
ui: &mut egui::Ui,
size: egui::Vec2,
selected: bool,
stripe: bool,
) -> (egui::Rect, egui::Response)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list.rs:16
platinum_sdk::file_manager::list::ListView
pub struct ListView
Shared list/grid presentation. Configuration and snapshots are host supplied;
painting queues semantic events and never opens files or calls application code.
Public data fields| Name | Type / declaration | Description |
|---|
| painted_entries | usize | Rows/cards painted in the last frame, for host profiling and virtualization checks. |
Source: crates/platinum-sdk/src/file_manager/list.rs:42
platinum_sdk::file_manager::list::ListView::rows
pub fn rows<R>(
scroll: egui::ScrollArea,
ui: &mut egui::Ui,
height: f32,
count: usize,
body: impl FnOnce(&mut egui::Ui, std::ops::Range<usize>) -> R,
) -> egui::scroll_area::ScrollAreaOutput<R>
Files supplies its columns/tree disclosure/drag handlers; all consumers
share this virtualized row primitive and the row painting above.
Source: crates/platinum-sdk/src/file_manager/list.rs:63
platinum_sdk::file_manager::list::ListView::show
pub fn show(&mut self, ui: &mut egui::Ui, files: &[String]) -> Option<String>
Compatibility adapter: returns the clicked name, preserving old script
pane behavior. New consumers use replace/configure/show_current and drain
typed events after paint. This adapter compares names but only normalizes
and filters on changes; a revisioned snapshot avoids even that comparison.
Source: crates/platinum-sdk/src/file_manager/list.rs:77
platinum_sdk::file_manager::list::ListView::show_current
pub fn show_current(&mut self, ui: &mut egui::Ui) -> Option<String>
The parent allocates the available size. There is no fixed list height.
Pointer and keyboard paths use the same state transitions/event queue.
Source: crates/platinum-sdk/src/file_manager/list.rs:107
platinum_sdk::file_manager::scoped
platinum_sdk::file_manager::scoped
Provisioned directory capabilities. The trusted host constructs this service;
wire requests cannot change its root, suffixes, rights or quotas. cap-std resolves
paths relative to an open directory capability, including during symlink races.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:1
platinum_sdk::file_manager::scoped::FileRules
pub struct FileRules
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| suffixes | Vec<String> | |
| writable | bool | |
| max_bytes | usize | |
| max_entries | usize | |
Source: crates/platinum-sdk/src/file_manager/scoped.rs:13
platinum_sdk::file_manager::scoped::FileRules::scripts
pub fn scripts() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:20
platinum_sdk::file_manager::scoped::FileRules::test_scripts
pub fn test_scripts() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:28
platinum_sdk::file_manager::scoped::FileRules::tests
pub fn tests() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:33
platinum_sdk::file_manager::scoped::FileRequest
pub enum FileRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:44
platinum_sdk::file_manager::scoped::FileReply
pub enum FileReply
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:77
platinum_sdk::file_manager::scoped::ScopedAccess
pub struct ScopedAccess
Current backend rights, disclosed without a root or grant token.
Public data fields| Name | Type / declaration | Description |
|---|
| revision | String | |
| writable | bool | |
| browse_folders | bool | |
| folder_targets | bool | |
Source: crates/platinum-sdk/src/file_manager/scoped.rs:91
platinum_sdk::file_manager::scoped::ScopedEntryKind
pub enum ScopedEntryKind
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:99
platinum_sdk::file_manager::scoped::ScopedEntry
pub struct ScopedEntry
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| kind | ScopedEntryKind | |
| version | String | |
| writable | bool | |
Source: crates/platinum-sdk/src/file_manager/scoped.rs:105
platinum_sdk::file_manager::scoped::ScopedFiles
pub struct ScopedFiles
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:111
platinum_sdk::file_manager::scoped::ScopedFiles::provision_subdirectory
pub fn provision_subdirectory(
root: &Path,
relative: &str,
rules: FileRules,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:121
platinum_sdk::file_manager::scoped::ScopedFiles::provision
pub fn provision(root: &Path, rules: FileRules) -> Result<Self, String>
Called by the provisioning host, never with a client supplied root/grant.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:143
platinum_sdk::file_manager::scoped::ScopedFiles::with_folder_access
pub fn with_folder_access(mut self, as_targets: bool) -> Self
Trusted provisioning only. Frontend requests cannot enable folder metadata
or folder targeting; existing text capabilities retain their old surface.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:166
platinum_sdk::file_manager::scoped::ScopedFiles::dispatch
pub fn dispatch(&self, request: FileRequest) -> Result<FileReply, String>
Shared application/IPC endpoint. A deserialized request has no ambient paths.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:292
platinum_sdk::file_manager::scoped::ScopedFiles::read
pub fn read(&self, path: &str) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:419
platinum_sdk::file_manager::scoped::ScopedFiles::write
pub fn write(&self, path: &str, text: String) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:425
platinum_sdk::file_manager::scoped::ScopedFiles::create_new
pub fn create_new(&self,path:&str,text:String)->Result<(),String>
Publish a complete new file without replacing an existing path. The
temporary file is synced before a same-directory no-replace hard link.
Unsupported filesystems return an error; no replacing fallback is used.
Directory entries are not fsynced, so this is not a power-loss durability
guarantee. This trusted local API does not add a wire command or rights.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:437
platinum_sdk::file_manager::scoped::ScopedFiles::list
pub fn list(&self) -> Result<Vec<String>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:458
platinum_sdk::file_manager::scoped::FileEndpoint
pub struct FileEndpoint
A provisioned frontend/backend channel. Its directory and policy cannot be
serialized or reconstructed by a frontend. Transport code binds this handle
to its authenticated connection; request JSON never contains authority.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:582
platinum_sdk::file_manager::scoped::FileClient
pub struct FileClient
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:586
platinum_sdk::file_manager::scoped::FileEndpoint::new
pub fn new(files: ScopedFiles) -> (Self, FileClient)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:591
platinum_sdk::file_manager::scoped::FileEndpoint::set_access
pub fn set_access(&self, writable: bool, folder_targets: bool) -> Result<(), String>
Trusted-host runtime restriction. Restoring a UI flag cannot exceed the
original provisioning grant. Updates serialize with dispatch and writes.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:606
platinum_sdk::file_manager::scoped::FileEndpoint::revoke
pub fn revoke(&self)
Serialized with operations, so no write can commit after revoke returns.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:620
platinum_sdk::file_manager::scoped::FileClient::status
pub fn status(&self) -> Result<ScopedAccess, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:627
platinum_sdk::file_manager::scoped::FileClient::entries
pub fn entries(&self) -> Result<(ScopedAccess, Vec<ScopedEntry>), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:633
platinum_sdk::file_manager::scoped::FileClient::inspect
pub fn inspect(&self, path: &str) -> Result<ScopedEntry, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:639
platinum_sdk::file_manager::scoped::FileClient::dispatch_wire
pub fn dispatch_wire(&self, json: &str) -> Result<FileReply, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:645
platinum_sdk::file_manager::scoped::FileClient::request
pub fn request(&self, request: FileRequest) -> Result<FileReply, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:656
platinum_sdk::file_manager::scoped::FileClient::read
pub fn read(&self, path: &str) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:659
platinum_sdk::file_manager::scoped::FileClient::write
pub fn write(&self, path: &str, text: String) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:665
platinum_sdk::file_manager::scoped::FileClient::list
pub fn list(&self) -> Result<Vec<String>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/scoped.rs:672
platinum_sdk::file_manager::list_scoped
platinum_sdk::file_manager::list_scoped
Native adapter over the existing opaque FileClient. All methods belong on
the host logic/I/O lane, never in ListView painting. A view flag is not a grant.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:1
platinum_sdk::file_manager::list_scoped::ScopedListAdapter
pub struct ScopedListAdapter
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:13
platinum_sdk::file_manager::list_scoped::ScopedListAdapter::new
pub fn new(client: FileClient) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:22
platinum_sdk::file_manager::list_scoped::ScopedListAdapter::refresh
pub fn refresh(&mut self) -> Result<ListSnapshot, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:35
platinum_sdk::file_manager::list_scoped::ScopedListAdapter::authorize
pub fn authorize(&self, event: &ListEventDto, policy: &ViewPolicy) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:86
platinum_sdk::file_manager::list_scoped::ScopedListAdapter::dispatch
pub fn dispatch(
&self,
state: &mut ListState,
events: Vec<ListEventDto>,
sink: impl FnMut(&AuthorizedListEvent<'_>) -> Result<(), String>,
) -> Vec<String>
Admission is rechecked immediately before each callback. A handler error
is reported once; this queue does not promise durable or exactly-once delivery.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:137
platinum_sdk::file_manager::list_scoped::ScopedListAdapter::write
pub fn write(
&mut self,
item: &EntryRef,
policy: &ViewPolicy,
text: String,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_scoped.rs:146
platinum_sdk::file_manager::list_lua
platinum_sdk::file_manager::list_lua
Optional native reference binder for the parent's versioned list API catalog.
Uses the existing host VM; neither view metadata nor DTOs serialize functions.
The host owns VM budgets and calls delivery only on its logic lane.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:1
platinum_sdk::file_manager::list_lua::LuaListCallbacks
pub struct LuaListCallbacks
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:9
platinum_sdk::file_manager::list_lua::LuaListCallbacks::subscribe
pub fn subscribe(
&mut self,
lua: &Lua,
view: &str,
subscription: &str,
handler: Function,
) -> mlua::Result<()>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:20
platinum_sdk::file_manager::list_lua::LuaListCallbacks::unsubscribe
pub fn unsubscribe(&mut self, lua: &Lua, subscription: &str) -> mlua::Result<()>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:55
platinum_sdk::file_manager::list_lua::LuaListCallbacks::clear
pub fn clear(&mut self, lua: &Lua) -> mlua::Result<()>
Drop subscriptions on principal/audience/resource changes as well as view close.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:62
platinum_sdk::file_manager::list_lua::LuaListCallbacks::deliver
pub fn deliver(&self, lua: &Lua, event: &AuthorizedListEvent<'_>) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/file_manager/list_lua.rs:69
platinum_sdk::game
platinum_sdk::game
Small reusable game-engine slice. Scene component definitions are real Bevy components.
Source: crates/platinum-sdk/src/game/mod.rs:1
platinum_sdk::game::AnimationInputs
pub type AnimationInputs
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:9
platinum_sdk::game::AnimationAsset
pub struct AnimationAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| duration | f32 | |
| looping | bool | |
| playback | AnimationDriveSettings | |
| inputs | AnimationInputs | |
| objects | Vec<AnimationObject> | |
| layers | Vec<AnimationLayer> | |
Source: crates/platinum-sdk/src/game/animation.rs:11
platinum_sdk::game::AnimationObject
pub struct AnimationObject
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| playback | AnimationPlaybackOptions | Override the asset's default for every transform track on this object. |
| spawn | Option<SceneObject> | Used only when this binding is omitted by the caller. IDs are allocated at playback. |
Source: crates/platinum-sdk/src/game/animation.rs:24
platinum_sdk::game::AnimationLayer
pub struct AnimationLayer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| enabled | bool | |
| weight | f32 | |
| additive | bool | |
| tracks | Vec<AnimationTrack> | |
Source: crates/platinum-sdk/src/game/animation.rs:34
platinum_sdk::game::AnimationTrack
pub struct AnimationTrack
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| object | String | |
| property | String | position.x/y/z, rotation.x/y/z (degrees), scale.x/y/z, or a custom presentation channel. |
| keys | Vec<AnimationKey> | |
Source: crates/platinum-sdk/src/game/animation.rs:43
platinum_sdk::game::AnimationKey
pub struct AnimationKey
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| time | f32 | |
| value | String | |
| interpolation | String | |
Source: crates/platinum-sdk/src/game/animation.rs:50
platinum_sdk::game::AnimationSample
pub struct AnimationSample
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| object | String | |
| property | String | |
| value | f32 | |
| additive | bool | |
| weight | f32 | |
Source: crates/platinum-sdk/src/game/animation.rs:56
platinum_sdk::game::AnimationAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:64
platinum_sdk::game::AnimationAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:69
platinum_sdk::game::AnimationAsset::sample
pub fn sample(&self, time: f32, inputs: &AnimationInputs, seed: u32) -> Vec<AnimationSample>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:137
platinum_sdk::game::expression
pub fn expression(
source: &str,
inputs: &AnimationInputs,
time: f32,
seed: u32,
) -> Result<f32, String>
Small bounded arithmetic language. No VM execution, file access or unbounded loops.
Variables are script inputs plus `time` and `pi`; functions sin/cos/abs/min/max/rand.
Source: crates/platinum-sdk/src/game/animation.rs:186
platinum_sdk::game::AnimationPlayback
pub struct AnimationPlayback
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset | AnimationAsset | |
| bindings | BTreeMap<String, u64> | |
| inputs | AnimationInputs | |
| time | f32 | |
| seed | u32 | |
| options | AnimationPlaybackOptions | |
Source: crates/platinum-sdk/src/game/animation.rs:377
platinum_sdk::game::AnimationPlayback::start_with_options
pub fn start_with_options(
asset: AnimationAsset,
bindings: BTreeMap<String, u64>,
inputs: AnimationInputs,
seed: u32,
scene: &mut SceneDocument,
options: AnimationPlaybackOptions,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:389
platinum_sdk::game::AnimationPlayback::start
pub fn start(
asset: AnimationAsset,
bindings: BTreeMap<String, u64>,
inputs: AnimationInputs,
seed: u32,
scene: &mut SceneDocument,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:405
platinum_sdk::game::AnimationPlayback::start_with_id_floor
pub fn start_with_id_floor(
asset: AnimationAsset,
mut bindings: BTreeMap<String, u64>,
inputs: AnimationInputs,
seed: u32,
scene: &mut SceneDocument,
min: Option<u64>,
) -> Result<Self, String>
`None` denotes exhausted entity IDs; clips using only existing bindings can still play.
Source: crates/platinum-sdk/src/game/animation.rs:422
platinum_sdk::game::AnimationPlayback::with_options
pub fn with_options(mut self, options: AnimationPlaybackOptions) -> Result<Self, String>
Runtime reference options take precedence over the object's and asset's defaults.
Source: crates/platinum-sdk/src/game/animation.rs:480
platinum_sdk::game::AnimationPlayback::drive_settings
pub fn drive_settings(&self, name: &str) -> AnimationDriveSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:490
platinum_sdk::game::AnimationPlayback::equipment_pose
pub fn equipment_pose(&self, id: u64) -> Option<super::EquipmentAnimationPose>
Held equipment applies object tracks relative to its captured binding base,
rather than teleporting back to the pickup's authored scene coordinates.
Source: crates/platinum-sdk/src/game/animation.rs:505
platinum_sdk::game::AnimationPlayback::physics_tick
pub fn physics_tick(
&mut self,
dt: f32,
scene: &mut SceneDocument,
) -> Vec<(u64, AnimationBodyTarget)>
Sample against the captured base, not the previous physical result. Only
authored channels are touched. A rigid body gets a target instead of a transform write.
Source: crates/platinum-sdk/src/game/animation.rs:543
platinum_sdk::game::AnimationPlayback::apply
pub fn apply(&self, scene: &mut SceneDocument)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:630
platinum_sdk::game::AnimationPlayback::tick
pub fn tick(&mut self, dt: f32, scene: &mut SceneDocument) -> bool
Authored-pose preview/scrubbing without a physics world. Runtime body
playback must use `physics_tick` and queue its targets into JoltWorld.
Source: crates/platinum-sdk/src/game/animation.rs:666
platinum_sdk::game::AnimationPlayback::spawned
pub fn spawned(&self) -> &[u64]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation.rs:678
platinum_sdk::game::AnimationPlaybackMode
pub enum AnimationPlaybackMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation_drive.rs:7
platinum_sdk::game::AnimationDriveSettings
pub struct AnimationDriveSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| mode | AnimationPlaybackMode | |
| force_scale | f32 | Multiplies motor strength. Zero releases the motor; damping also scales with strength. |
| frequency | f32 | |
| damping | f32 | |
Source: crates/platinum-sdk/src/game/animation_drive.rs:16
platinum_sdk::game::AnimationPlaybackOptions
pub struct AnimationPlaybackOptions
Optional playback-reference overrides. Unspecified fields inherit asset/object defaults.
Public data fields| Name | Type / declaration | Description |
|---|
| mode | Option<AnimationPlaybackMode> | |
| force_scale | Option<f32> | |
| force_multiplier | Option<f32> | Multiplies the inherited/default force scale for this playback reference. |
Source: crates/platinum-sdk/src/game/animation_drive.rs:36
platinum_sdk::game::AnimationDriveSettings::validate
pub fn validate(self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation_drive.rs:43
platinum_sdk::game::AnimationDriveSettings::with_options
pub fn with_options(mut self, options: AnimationPlaybackOptions) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation_drive.rs:58
platinum_sdk::game::AnimationBodyTarget
pub struct AnimationBodyTarget
A resolved target is sampled once, before physics. Physics must never sample its own output.
Public data fields| Name | Type / declaration | Description |
|---|
| position | [f32; 3] | |
| rotation | [f32; 4] | |
| settings | AnimationDriveSettings | |
| translation_axes | [bool; 3] | Authored axes only. Unkeyed axes stay under physics control. |
| rotation_axes | [bool; 3] | |
Source: crates/platinum-sdk/src/game/animation_drive.rs:78
platinum_sdk::game::AnimationBodyTarget::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation_drive.rs:87
platinum_sdk::game::AnimationBodyTarget::angular_impulse
pub fn angular_impulse(
&self,
delta: Vec3,
rotation: Quat,
spec: &super::RigidBody,
scale: Vec3,
) -> Vec3
Shape-aware diagonal inertia in the body's local frame (capsules use a
conservative enclosing cylinder). Torque is rotated back to world space.
Source: crates/platinum-sdk/src/game/animation_drive.rs:102
platinum_sdk::game::AnimationBodyTarget::transform
pub fn transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/animation_drive.rs:134
platinum_sdk::game::AnimationBodyTarget::velocity_delta
pub fn velocity_delta(
&self,
position: Vec3,
rotation: Quat,
velocity: Vec3,
angular: Vec3,
dt: f32,
) -> (Vec3, Vec3)
Implicit damped spring: bounded and non-oscillating at critical damping,
even when playback runs slower than the requested motor frequency.
Source: crates/platinum-sdk/src/game/animation_drive.rs:140
platinum_sdk::game::Spark
pub struct Spark
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| position | Vec3 | |
| previous | Vec3 | |
| velocity | Vec3 | |
| age | f32 | |
| life | f32 | |
| target | bool | |
Source: crates/platinum-sdk/src/game/presentation.rs:6
platinum_sdk::game::Tracer
pub struct Tracer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| from | Vec3 | |
| to | Vec3 | |
| age | f32 | |
| life | f32 | |
Source: crates/platinum-sdk/src/game/presentation.rs:15
platinum_sdk::game::Impact
pub struct Impact
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| point | Vec3 | |
| normal | Vec3 | |
| age | f32 | |
| target | bool | |
Source: crates/platinum-sdk/src/game/presentation.rs:22
platinum_sdk::game::PresentationDisplay
pub struct PresentationDisplay
Cosmetic channels only; excludes solver state, Lua, animation graphs and world rules.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| channels | BTreeMap<String, AnimationChannelDisplay> | |
Source: crates/platinum-sdk/src/game/presentation.rs:31
platinum_sdk::game::AnimationChannelDisplay
pub struct AnimationChannelDisplay
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| time | f32 | |
| inputs | AnimationInputs | |
| seed | u32 | |
Source: crates/platinum-sdk/src/game/presentation.rs:37
platinum_sdk::game::PresentationDisplay::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:43
platinum_sdk::game::Presentation
pub struct Presentation
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| particles | Vec<Spark> | |
| tracers | Vec<Tracer> | |
| impacts | Vec<Impact> | |
| flash | f32 | |
| hit_marker | f32 | |
| score_popup | f32 | |
| score_delta | i32 | |
| recoil | f32 | |
| bob | Vec3 | |
| roll | f32 | |
| sway | Vec2 | |
| equip_age | f32 | |
| motion_enabled | bool | |
| sprint_weight | f32 | |
| tactical_weight | f32 | |
| brake_weight | f32 | |
| steering_lean | f32 | |
| animations | BTreeMap<String, AnimationAsset> | |
Source: crates/platinum-sdk/src/game/presentation.rs:66
platinum_sdk::game::Presentation::new
pub fn new(position: Vec3) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:103
platinum_sdk::game::Presentation::load_animations
pub fn load_animations(&mut self, root: &Path) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:174
platinum_sdk::game::Presentation::display_state
pub fn display_state(&self) -> PresentationDisplay
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:192
platinum_sdk::game::Presentation::apply_display_state
pub fn apply_display_state(&mut self, display: &PresentationDisplay) -> Result<(), String>
Atomic validation before replacement; subsequent ticking is cosmetic only.
Source: crates/platinum-sdk/src/game/presentation.rs:212
platinum_sdk::game::Presentation::trigger
pub fn trigger(&mut self, path: &str, inputs: &AnimationInputs, seed: u32) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:227
platinum_sdk::game::Presentation::locomotion
pub fn locomotion(&mut self, state: super::SprintState, sprinting: bool, dt: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:280
platinum_sdk::game::Presentation::camera
pub fn camera(&self, mut base: Transform) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:298
platinum_sdk::game::Presentation::equip_duration
pub fn equip_duration(&self) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:306
platinum_sdk::game::Presentation::weapon_transform
pub fn weapon_transform(&self, camera: Transform) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:311
platinum_sdk::game::Presentation::tick
pub fn tick(
&mut self,
dt: f32,
position: Vec3,
grounded: bool,
look: Vec2,
weapon: Option<(u64, Transform)>,
trace: Option<ShotTrace>,
score: i32,
camera: Transform,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation.rs:370
platinum_sdk::game::EventItem
pub enum EventItem
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:6
platinum_sdk::game::EventDestination
pub enum EventDestination
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:21
platinum_sdk::game::InsertPosition
pub enum InsertPosition
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:29
platinum_sdk::game::EventFragment
pub enum EventFragment
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:36
platinum_sdk::game::EventFragment::encode
pub fn encode(&self) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:56
platinum_sdk::game::EventFragment::decode
pub fn decode(s: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:61
platinum_sdk::game::EventHistory
pub struct EventHistory
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:74
platinum_sdk::game::EventHistory::can_undo
pub fn can_undo(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:80
platinum_sdk::game::EventHistory::can_redo
pub fn can_redo(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:83
platinum_sdk::game::EventHistory::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:86
platinum_sdk::game::EventHistory::record
pub fn record(&mut self, before: &EventTable, after: &EventTable, merge: Option<String>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:89
platinum_sdk::game::EventHistory::undo
pub fn undo(&mut self, table: &mut EventTable) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:106
platinum_sdk::game::EventHistory::redo
pub fn redo(&mut self, table: &mut EventTable) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_edit.rs:115
platinum_sdk::game::EventMetadata
pub struct EventMetadata
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| category | String | |
| description | String | |
| inputs | std::collections::BTreeMap<String, String> | |
Source: crates/platinum-sdk/src/game/event_metadata.rs:5
platinum_sdk::game::EventCatalog
pub struct EventCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| events | Vec<EventMetadata> | |
Source: crates/platinum-sdk/src/game/event_metadata.rs:16
platinum_sdk::game::EventCatalog::load
pub fn load(root: &std::path::Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_metadata.rs:21
platinum_sdk::game::EventCatalog::label
pub fn label(&self, id: &str) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_metadata.rs:51
platinum_sdk::game::human_event_name
pub fn human_event_name(id: &str) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_metadata.rs:59
platinum_sdk::game::EventTable
pub struct EventTable
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| overrides | Vec<String> | Matching events replace handlers inherited from broader scopes. |
| receive_global_events | bool | |
| rules | Vec<EventRule> | |
| columns | Vec<EventColumn> | |
| rows | Vec<EventRow> | |
| groups | Vec<EventGroup> | |
Source: crates/platinum-sdk/src/game/events.rs:8
platinum_sdk::game::EventRule
pub struct EventRule
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| event | String | |
| condition | String | |
| action | String | |
| argument | String | |
Source: crates/platinum-sdk/src/game/events.rs:26
platinum_sdk::game::ObjectSelector
pub struct ObjectSelector
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| kind | String | |
| value | String | |
Source: crates/platinum-sdk/src/game/events.rs:35
platinum_sdk::game::ObjectSelector::source
pub fn source() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:41
platinum_sdk::game::ObjectSelector::system
pub fn system() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:47
platinum_sdk::game::ObjectSelector::of_type
pub fn of_type(name: &str) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:53
platinum_sdk::game::ObjectSelector::entity
pub fn entity(id: u64) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:59
platinum_sdk::game::ObjectSelector::matches
pub fn matches(&self, object: &SceneObject, source: u64) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:65
platinum_sdk::game::ENTITY_TYPES
pub const ENTITY_TYPES: &[&str]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:76
platinum_sdk::game::entity_has_type
pub fn entity_has_type(o: &SceneObject, kind: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:92
platinum_sdk::game::EventColumn
pub struct EventColumn
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| selector | ObjectSelector | |
Source: crates/platinum-sdk/src/game/events.rs:113
platinum_sdk::game::EventGroup
pub struct EventGroup
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| enabled | bool | |
| collapsed | bool | |
Source: crates/platinum-sdk/src/game/events.rs:118
platinum_sdk::game::EventCondition
pub struct EventCondition
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| kind | String | |
| expression | String | |
| children | Vec<EventCondition> | |
Source: crates/platinum-sdk/src/game/events.rs:129
platinum_sdk::game::EventCondition::expression
pub fn expression(value: impl Into<String>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:137
platinum_sdk::game::EventCondition::combine
pub fn combine(&mut self, kind: &str, next: Self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:144
platinum_sdk::game::EventCondition::evaluate
pub fn evaluate(&self, vars: &AnimationInputs) -> Result<bool, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:155
platinum_sdk::game::EventCondition::summary
pub fn summary(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:201
platinum_sdk::game::EventRow
pub struct EventRow
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| event | String | |
| condition | String | |
| cells | Vec<EventCell> | |
| depth | u8 | |
| group | String | |
| collapsed | bool | |
| condition_mode | String | |
Source: crates/platinum-sdk/src/game/events.rs:220
platinum_sdk::game::EventCell
pub struct EventCell
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| column | usize | |
| condition | String | |
| actions | Vec<EventAction> | |
| filter | Option<EventCondition> | |
Source: crates/platinum-sdk/src/game/events.rs:237
platinum_sdk::game::EventCell::add_condition
pub fn add_condition(&mut self, expression: String, operator: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:247
platinum_sdk::game::EventCell::condition_summary
pub fn condition_summary(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:265
platinum_sdk::game::EventAction
pub struct EventAction
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| kind | String | |
| argument | String | |
| property | String | |
Source: crates/platinum-sdk/src/game/events.rs:274
platinum_sdk::game::GameEvent
pub struct GameEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| context | EventContext | |
| name | String | |
| source | u64 | |
| inputs | AnimationInputs | |
Source: crates/platinum-sdk/src/game/events.rs:282
platinum_sdk::game::ResolvedEventAction
pub struct ResolvedEventAction
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| target | Option<u64> | |
| action | EventAction | |
| inputs | AnimationInputs | |
| row | usize | |
Source: crates/platinum-sdk/src/game/events.rs:289
platinum_sdk::game::EVENT_TRIGGERS
pub const EVENT_TRIGGERS: &[(&str, &str)]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:295
platinum_sdk::game::EventPicks
pub type EventPicks
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:334
platinum_sdk::game::EventSelection
pub struct EventSelection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| actions | Vec<ResolvedEventAction> | |
| picks | EventPicks | |
Source: crates/platinum-sdk/src/game/events.rs:335
platinum_sdk::game::EVENT_ACTIONS
pub const EVENT_ACTIONS: &[(&str, &str)]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:339
platinum_sdk::game::EventTable::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:383
platinum_sdk::game::EventTable::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:422
platinum_sdk::game::EventTable::matching
pub fn matching(&self, event: &GameEvent) -> Vec<EventRule>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:549
platinum_sdk::game::EventTable::plan
pub fn plan(
&self,
event: &GameEvent,
scene: &SceneDocument,
hidden: &HashSet<u64>,
state: &HashMap<u64, AnimationInputs>,
) -> Result<Vec<ResolvedEventAction>, String>
Selection is isolated for every row and column. All nonempty condition cells must match.
Actions-only columns apply to all matching instances; a System action executes once.
Source: crates/platinum-sdk/src/game/events.rs:564
platinum_sdk::game::EventTable::plan_row
pub fn plan_row(
&self,
row: usize,
event: &GameEvent,
scene: &SceneDocument,
hidden: &HashSet<u64>,
state: &HashMap<u64, AnimationInputs>,
) -> Result<Vec<ResolvedEventAction>, String>
The runtime resolves each row after the preceding row's actions have completed.
Source: crates/platinum-sdk/src/game/events.rs:574
platinum_sdk::game::EventTable::add_child
pub fn add_child(&mut self, index: usize) -> Result<usize, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:584
platinum_sdk::game::EventTable::indent
pub fn indent(&mut self, index: usize) -> Result<usize, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:606
platinum_sdk::game::EventTable::outdent
pub fn outdent(&mut self, index: usize) -> Result<usize, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:624
platinum_sdk::game::EventTable::move_event
pub fn move_event(&mut self, index: usize, down: bool) -> Result<usize, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:642
platinum_sdk::game::EventTable::subtree_end
pub fn subtree_end(&self, index: usize) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:661
platinum_sdk::game::EventTable::subscribes
pub fn subscribes(&self, event: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:667
platinum_sdk::game::EventTable::group_active
pub fn group_active(&self, index: usize) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:670
platinum_sdk::game::EventTable::pick_row
pub fn pick_row(
&self,
index: usize,
event: &GameEvent,
scene: &SceneDocument,
hidden: &HashSet<u64>,
state: &HashMap<u64, AnimationInputs>,
inherited: Option<&EventPicks>,
) -> Result<Option<EventSelection>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:687
platinum_sdk::game::EventTable::pick_row_scoped
pub fn pick_row_scoped(
&self,
index: usize,
event: &GameEvent,
scene: &SceneDocument,
hidden: &HashSet<u64>,
state: &HashMap<u64, AnimationInputs>,
inherited: Option<&EventPicks>,
universe: Option<&HashSet<u64>>,
) -> Result<Option<EventSelection>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:698
platinum_sdk::game::TRANSFORM_PROPERTIES
pub const TRANSFORM_PROPERTIES: &[&str]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:997
platinum_sdk::game::object_values
pub fn object_values(o: &SceneObject, hidden: bool) -> AnimationInputs
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:1015
platinum_sdk::game::EventContext
pub struct EventContext
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| instigator | Option<u64> | |
| target | Option<u64> | |
| scope_owner | Option<u64> | |
| labels | std::collections::BTreeMap<String, String> | |
Source: crates/platinum-sdk/src/game/events.rs:1109
platinum_sdk::game::EventContext::expand
pub fn expand(&self, text: &str) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:1117
platinum_sdk::game::EventTable::handles
pub fn handles(&self, name: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/events.rs:1126
platinum_sdk::game::EventScopes
pub struct EventScopes
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/event_scopes.rs:5
platinum_sdk::game::ParticleAsset
pub struct ParticleAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| capacity | u32 | |
| seed | u32 | |
| emission | String | |
| rate | f32 | |
| burst | u32 | |
| lifetime | [f32; 2] | |
| speed | [f32; 2] | |
| radius | f32 | |
| spread | f32 | |
| direction | [f32; 3] | |
| acceleration | [f32; 3] | |
| drag | f32 | |
| shape | String | |
| size | [f32; 2] | |
| colors | Vec<ParticleColorKey> | |
| blend | String | |
Source: crates/platinum-sdk/src/game/particles.rs:28
platinum_sdk::game::ParticleColorKey
pub struct ParticleColorKey
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| time | f32 | |
| color | [f32; 4] | |
Source: crates/platinum-sdk/src/game/particles.rs:48
platinum_sdk::game::ParticleAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/particles.rs:89
platinum_sdk::game::ParticleAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/particles.rs:94
platinum_sdk::game::ParticleAsset::compile
pub fn compile(&self) -> Result<EffectAsset, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/particles.rs:152
platinum_sdk::game::ParticleEmitter
pub struct ParticleEmitter
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset | String | |
| overrides | Option<ParticleAsset> | Authored instance settings. The source asset remains unchanged until explicitly applied. |
| enabled | bool | |
| offset | [f32; 3] | |
| rotation | [f32; 3] | |
| scale | f32 | |
Source: crates/platinum-sdk/src/game/particles.rs:223
platinum_sdk::game::ParticleRequest
pub struct ParticleRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scene | Option<String> | |
| asset | String | |
| position | Vec3 | |
| rotation | Quat | |
| scale | f32 | |
| duration | f32 | |
| key | Option<u64> | |
Source: crates/platinum-sdk/src/game/particles.rs:246
platinum_sdk::game::ParticleCue
pub struct ParticleCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | super::CueId | |
| request | ParticleRequest | |
Source: crates/platinum-sdk/src/game/particles.rs:257
platinum_sdk::game::PHYSICS_DT
pub const PHYSICS_DT: f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_data.rs:3
platinum_sdk::game::PhysicsRayHit
pub struct PhysicsRayHit
An immutable physics query result, using scene IDs on every backend.
Public data fields| Name | Type / declaration | Description |
|---|
| object | u64 | |
| position | Vec3 | |
| normal | Vec3 | |
| distance | f32 | |
Source: crates/platinum-sdk/src/game/physics_data.rs:6
platinum_sdk::game::RigidBody
pub struct RigidBody
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| motion | String | |
| shape | String | |
| half_extents | [f32; 3] | |
| radius | f32 | |
| height | f32 | |
| offset | [f32; 3] | |
| mass | f32 | |
| friction | f32 | |
| restitution | f32 | |
| gravity_factor | f32 | |
| linear_damping | f32 | |
| angular_damping | f32 | |
| sensor | bool | |
| ccd | bool | |
| velocity | [f32; 3] | |
Source: crates/platinum-sdk/src/game/physics_data.rs:14
platinum_sdk::game::RigidBody::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_data.rs:53
platinum_sdk::game::PhysicsBodyState
pub struct PhysicsBodyState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| handle | u32 | |
| position | Vec3 | |
| rotation | Quat | |
| velocity | Vec3 | |
| angular_velocity | Vec3 | |
| active | bool | |
| tick | u64 | |
Source: crates/platinum-sdk/src/game/physics_data.rs:91
platinum_sdk::game::PhysicsCommand
pub enum PhysicsCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_data.rs:101
platinum_sdk::game::PhysicsContact
pub struct PhysicsContact
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| a | u64 | |
| b | u64 | |
| kind | String | |
| normal | Vec3 | |
| tick | u64 | |
Source: crates/platinum-sdk/src/game/physics_data.rs:109
platinum_sdk::game::JoltWorld
pub struct JoltWorld
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| character_stances | BTreeMap<u64, bool> | |
| states | BTreeMap<u64, PhysicsBodyState> | |
| tick | u64 | |
| pending | Vec<PhysicsCommand> | |
Source: crates/platinum-sdk/src/game/physics.rs:17
platinum_sdk::game::JoltWorld::raycast
pub fn raycast(
&self,
origin: Vec3,
direction: Vec3,
exclude: Option<u64>,
) -> Option<PhysicsRayHit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:161
platinum_sdk::game::JoltWorld::new
pub fn new() -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:187
platinum_sdk::game::JoltWorld::queue
pub fn queue(&mut self, command: PhysicsCommand) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:207
platinum_sdk::game::JoltWorld::sync
pub fn sync(
&mut self,
scene: &SceneDocument,
hidden: &HashSet<u64>,
player: Option<(u64, Vec3)>,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:217
platinum_sdk::game::JoltWorld::step
pub fn step(&mut self, scene: &mut SceneDocument) -> Result<Vec<PhysicsContact>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:402
platinum_sdk::game::JoltWorld::digest
pub fn digest(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics.rs:597
platinum_sdk::game::JoltWorld
pub struct JoltWorld
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| character_stances | BTreeMap<u64, bool> | |
| states | BTreeMap<u64, PhysicsBodyState> | |
| tick | u64 | |
| pending | Vec<PhysicsCommand> | |
Source: crates/platinum-sdk/src/game/physics_web.rs:22
platinum_sdk::game::JoltWorld::raycast
pub fn raycast(
&self,
origin: Vec3,
direction: Vec3,
exclude: Option<u64>,
) -> Option<PhysicsRayHit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:36
platinum_sdk::game::JoltWorld::new
pub fn new() -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:58
platinum_sdk::game::JoltWorld::queue
pub fn queue(&mut self, command: PhysicsCommand) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:70
platinum_sdk::game::JoltWorld::sync
pub fn sync(
&mut self,
scene: &SceneDocument,
hidden: &HashSet<u64>,
player: Option<(u64, Vec3)>,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:80
platinum_sdk::game::JoltWorld::step
pub fn step(&mut self, scene: &mut SceneDocument) -> Result<Vec<PhysicsContact>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:141
platinum_sdk::game::JoltWorld::digest
pub fn digest(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/physics_web.rs:219
platinum_sdk::game::HoverLegSettings
pub struct HoverLegSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| mass | f32 | |
| leg_height | f32 | |
| skirt_radius | f32 | |
| probe_length | f32 | |
| step_height | f32 | |
| spring_frequency | f32 | |
| damping_ratio | f32 | |
| max_support_acceleration | f32 | |
| acceleration | f32 | |
| braking | f32 | |
| air_acceleration | f32 | |
| max_compression | f32 | |
Source: crates/platinum-sdk/src/game/hover.rs:10
platinum_sdk::game::HoverLegSettings::validate
pub fn validate(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/hover.rs:43
platinum_sdk::game::character_capsule
pub fn character_capsule(controller: &PlayerController) -> (f32, f32)
Torso/head movement proxy. Damage queries must use the character hit mesh.
Source: crates/platinum-sdk/src/game/hover.rs:64
platinum_sdk::game::hover_support
pub fn hover_support(
position: Vec3,
controller: &PlayerController,
objects: &[SceneObject],
hidden: &HashSet<u64>,
) -> Option<f32>
A center probe plus eight skirt probes. At least three peripheral supports are
needed when the center is over a gap; one toe cannot support a floating pawn.
Source: crates/platinum-sdk/src/game/hover.rs:77
platinum_sdk::game::step_hover_velocity
pub fn step_hover_velocity(
position: &mut Vec3,
velocity: &mut Vec3,
grounded: &mut bool,
world_velocity: Vec3,
jump: bool,
dt: f32,
controller: &PlayerController,
objects: &[SceneObject],
hidden: &HashSet<u64>,
) -> bool
Integrate support and collision after an external locomotion motor has already
integrated horizontal acceleration. The supplied velocity is world space and
is not normalized, speed-clamped, or accelerated a second time.
Source: crates/platinum-sdk/src/game/hover.rs:181
platinum_sdk::game::legacy
platinum_sdk::game::legacy
Compatibility migration for the original version-one lighthouse mockup.
New projects author components explicitly; these rules never run for version two.
Source: crates/platinum-sdk/src/game/legacy.rs:1
platinum_sdk::game::legacy::hydrate_bounds
pub fn hydrate_bounds(scene:&mut SceneDocument)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/legacy.rs:4
platinum_sdk::game::legacy::default_components
pub fn default_components(asset: &str) -> GameComponents
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/legacy.rs:21
platinum_sdk::game::legacy::add_demo_objects
pub fn add_demo_objects(scene: &mut SceneDocument)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/legacy.rs:58
platinum_sdk::game::PlayerSpawn
pub struct PlayerSpawn
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| yaw | f32 | |
Source: crates/platinum-sdk/src/game/scene.rs:10
platinum_sdk::game::PlayerController
pub struct PlayerController
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| hover | Option<super::HoverLegSettings> | |
| max_health | f32 | |
| speed | f32 | |
| sprint_speed | f32 | |
| sprint | super::SprintSettings | |
| jump_speed | f32 | |
| gravity | f32 | |
| radius | f32 | |
| height | f32 | |
| eye_height | f32 | |
| sensitivity | f32 | |
Source: crates/platinum-sdk/src/game/scene.rs:24
platinum_sdk::game::WeaponPickup
pub struct WeaponPickup
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| damage | f32 | |
| range | f32 | |
| cooldown | f32 | |
| magazine_size | u32 | Zero keeps a continuous-use tool or unlimited weapon. |
| reload_seconds | f32 | |
| pickup_radius | f32 | |
| mode | String | |
| projectile_speed | f32 | |
| blast_radius | f32 | |
| projectile_asset | Option<String> | |
| fire_effect | Option<String> | |
| hand_grips | BTreeMap<String, super::character::EquipmentGrip> | |
| mobility | super::GearMobility | |
| animation_playback | super::AnimationDriveSettings | Equipment owns its animated pose; character hands follow the resolved item. |
Source: crates/platinum-sdk/src/game/scene.rs:56
platinum_sdk::game::ShootTarget
pub struct ShootTarget
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| health | f32 | |
| points | i32 | |
| respawn_seconds | f32 | |
| aim_offset | [f32; 3] | |
Source: crates/platinum-sdk/src/game/scene.rs:98
platinum_sdk::game::Collider
pub struct Collider
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| shape | String | |
| half_extents | [f32; 3] | |
| offset | [f32; 3] | |
| solid | bool | |
| walkable | bool | |
Source: crates/platinum-sdk/src/game/scene.rs:116
platinum_sdk::game::LuaScript
pub struct LuaScript
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| enabled | bool | |
| properties | BTreeMap<String, serde_json::Value> | |
Source: crates/platinum-sdk/src/game/scene.rs:136
platinum_sdk::game::MeshRenderer
pub struct MeshRenderer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| material | Option<String> | Project-relative procedural material, applied to all meshes below this object. |
| material_instance | super::material::MaterialOverrides | |
| cast_shadows | bool | |
| receive_shadows | bool | |
| bounds_min | Option<[f32; 3]> | |
| bounds_max | Option<[f32; 3]> | |
Source: crates/platinum-sdk/src/game/scene.rs:152
platinum_sdk::game::GameComponents
pub struct GameComponents
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scene_membership | Option<super::SceneMembership> | |
| player_spawn | Option<PlayerSpawn> | |
| player_controller | Option<PlayerController> | |
| weapon_pickup | Option<WeaponPickup> | |
| target | Option<ShootTarget> | |
| health_pickup | Option<super::HealthPickup> | |
| flag_team | Option<u8> | |
| event_tables | Vec<String> | |
| collider | Option<Collider> | |
| script | Option<LuaScript> | |
| mesh_renderer | Option<MeshRenderer> | |
| beacon_light | Option<BeaconLight> | |
| rigid_body | Option<super::RigidBody> | |
| particle_emitter | Option<super::ParticleEmitter> | |
| character_rig | Option<super::character::CharacterRig> | |
| sound_emitter | Option<super::audio::SoundEmitter> | |
Source: crates/platinum-sdk/src/game/scene.rs:175
platinum_sdk::game::BeaconLight
pub struct BeaconLight
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| color | [f32; 3] | |
| intensity | f32 | |
| range | f32 | |
| offset | [f32; 3] | |
| downward | f32 | |
Source: crates/platinum-sdk/src/game/scene.rs:196
platinum_sdk::game::SceneObject
pub struct SceneObject
Authoring snapshot attached alongside individual typed components on scene entities.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| name | String | |
| asset | String | |
| position | [f32; 3] | |
| rotation | [f32; 3] | |
| scale | [f32; 3] | |
| visible | bool | |
| components | GameComponents | |
| instance | Option<super::AssetInstance> | |
Source: crates/platinum-sdk/src/game/scene.rs:216
platinum_sdk::game::SceneObject::transform
pub fn transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:230
platinum_sdk::game::SceneObject::new
pub fn new(id: u64, name: &str, asset: &str, position: [f32; 3]) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:242
platinum_sdk::game::SceneObject::bounds
pub fn bounds(&self) -> (Vec3, Vec3)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:262
platinum_sdk::game::SceneDocument
pub struct SceneDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| streaming | super::SceneStreamingConfig | |
| version | u32 | |
| name | String | |
| objects | Vec<SceneObject> | |
| beacon_speed | f32 | |
Source: crates/platinum-sdk/src/game/scene.rs:285
platinum_sdk::game::project_relative
pub fn project_relative(path: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:297
platinum_sdk::game::SceneDocument::parse
pub fn parse(bytes: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:310
platinum_sdk::game::SceneDocument::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:323
platinum_sdk::game::SceneObject::validate
pub fn validate(&self)->Result<(),String>
Validate a single proposed object without cloning/serializing the world.
Scene-wide identity/structure checks remain SceneDocument's obligation.
Source: crates/platinum-sdk/src/game/scene.rs:342
platinum_sdk::game::SceneDocument::replace_object_if_unchanged
pub fn replace_object_if_unchanged(&mut self,expected:&SceneObject,replacement:SceneObject)->Result<bool,String>
Trusted domain command. The enclosing authority must still fence the
scene document/incarnation and authorize the caller before invocation.
A stale object baseline never overwrites another author's changes.
Source: crates/platinum-sdk/src/game/scene.rs:556
platinum_sdk::game::script
pub fn script(path: &str, properties: &[(&str, serde_json::Value)]) -> LuaScript
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene.rs:567
platinum_sdk::game::ScopedLuaCommand
pub struct ScopedLuaCommand
Owner is an executing player's pawn/source entity identity, not a float or UI widget ID.
Public data fields| Name | Type / declaration | Description |
|---|
| player | u64 | |
| actor | u64 | |
| command | LuaCommand | |
Source: crates/platinum-sdk/src/game/scripting.rs:16
platinum_sdk::game::LuaHost
pub struct LuaHost
Long-lived Lua 5.4 VM with isolated per-object environments and exposed properties.
Public data fields| Name | Type / declaration | Description |
|---|
| errors | Vec<String> | |
| calls | u64 | |
Source: crates/platinum-sdk/src/game/scripting.rs:148
platinum_sdk::game::LuaHost::new
pub fn new(root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:163
platinum_sdk::game::LuaHost::set_game_state
pub fn set_game_state(
&mut self,
values: &std::collections::BTreeMap<String, serde_json::Value>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:467
platinum_sdk::game::LuaHost::check
pub fn check(source: &str, name: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:488
platinum_sdk::game::LuaHost::sync_scene_data
pub fn sync_scene_data(&mut self, data: super::SceneQueryData)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:519
platinum_sdk::game::LuaHost::suspend
pub fn suspend(&mut self, id: u64, suspended: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:524
platinum_sdk::game::LuaHost::has_actor
pub fn has_actor(&self, id: u64) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:531
platinum_sdk::game::LuaHost::install
pub fn install(&mut self, object: &SceneObject) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:534
platinum_sdk::game::LuaHost::sync_properties
pub fn sync_properties(&mut self, object: &SceneObject)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:596
platinum_sdk::game::LuaHost::sync_player
pub fn sync_player(
&mut self,
id: u64,
inventory: &[u64],
equipped: Option<u64>,
grounded: bool,
position: Vec3,
velocity: Vec3,
)
Read-only controller/character view. IDs remain Lua integers, or decimal strings
outside Lua's signed integer range; they never become floating-point values.
Source: crates/platinum-sdk/src/game/scripting.rs:615
platinum_sdk::game::LuaHost::sync_ui_state
pub fn sync_ui_state(&mut self, source: u64, revision: u64, view: &super::ui::UiQueryView)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:663
platinum_sdk::game::LuaHost::sync_health
pub fn sync_health(&mut self, id: u64, health: f32, max_health: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:670
platinum_sdk::game::LuaHost::game_event
pub fn game_event(&mut self, id: u64, event: &super::GameEvent)
Game mode authority hook. Identity fields stay exact Lua integers/decimal strings.
Source: crates/platinum-sdk/src/game/scripting.rs:687
platinum_sdk::game::LuaHost::ui_event
pub fn ui_event(&mut self, id: u64, action: &str, value: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:731
platinum_sdk::game::LuaHost::has_callback
pub fn has_callback(&self, id: u64, name: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:796
platinum_sdk::game::LuaHost::update
pub fn update(&mut self, id: u64, dt: f32, input: GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:801
platinum_sdk::game::LuaHost::hit
pub fn hit(&mut self, id: u64, damage: f32, shooter: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:804
platinum_sdk::game::LuaHost::pickup
pub fn pickup(&mut self, id: u64, player: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:825
platinum_sdk::game::LuaHost::gear_event
pub fn gear_event(&mut self, id: u64, name: &str, player: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:828
platinum_sdk::game::LuaHost::remove
pub fn remove(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:849
platinum_sdk::game::LuaHost::fixed_update
pub fn fixed_update(&mut self, id: u64, tick: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:856
platinum_sdk::game::LuaHost::sync_physics
pub fn sync_physics(&mut self, id: u64, body: &super::PhysicsBodyState)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:874
platinum_sdk::game::LuaHost::contact
pub fn contact(
&mut self,
id: u64,
other: u64,
event: &super::PhysicsContact,
normal: bevy::prelude::Vec3,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:894
platinum_sdk::game::LuaHost::set_execution_owner
pub fn set_execution_owner(&mut self, player: u64)
Set before entering a callback. Each queued command captures this owner immediately.
Source: crates/platinum-sdk/src/game/scripting.rs:936
platinum_sdk::game::LuaHost::drain_scoped
pub fn drain_scoped(&mut self) -> Vec<ScopedLuaCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:939
platinum_sdk::game::LuaHost::drain
pub fn drain(&mut self) -> Vec<LuaCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:942
platinum_sdk::game::LuaHost::capture_reflected
pub fn capture_reflected(
&self,
) -> Result<std::collections::BTreeMap<u64, serde_json::Value>, String>
Capture script-visible reflected instance data. Functions/closures and VM
implementation state are not reflected fields and remain owned by source.
Source: crates/platinum-sdk/src/game/scripting.rs:1205
platinum_sdk::game::LuaHost::restore_reflected
pub fn restore_reflected(
&mut self,
states: &std::collections::BTreeMap<u64, serde_json::Value>,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting.rs:1219
platinum_sdk::game::lua_catalog
platinum_sdk::game::lua_catalog
Public Game Lua API inventory emitted from actual command registrations.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:1
platinum_sdk::game::lua_catalog::GAME_LUA_API_REVISION
pub const GAME_LUA_API_REVISION: u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:77
platinum_sdk::game::lua_catalog::GAME_LUA_MODULE
pub const GAME_LUA_MODULE: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:78
platinum_sdk::game::lua_catalog::GAME_LUA_BRIDGE_SCHEMA
pub const GAME_LUA_BRIDGE_SCHEMA: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:79
platinum_sdk::game::lua_catalog::game_lua_catalog
pub fn game_lua_catalog() -> ApiCatalog
Pure descriptor generation: the registration macro's command bodies are ignored,
not compiled into metadata or executed. No Lua VM or project source is loaded.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:263
platinum_sdk::game::lua_catalog::game_lua_environment
pub fn game_lua_environment(target: &str) -> ApiEnvironment
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:334
platinum_sdk::game::lua_catalog::GameLuaBridgeCatalog
pub struct GameLuaBridgeCatalog
Browser command setup is generated from the same native registration definitions.
Public data fields| Name | Type / declaration | Description |
|---|
| schema_version | u32 | |
| catalog_revision | u64 | |
| commands | Vec<GameLuaBridgeCommand> | |
| functions | Vec<String> | Full engine function inventory, including query functions and aliases. |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:345
platinum_sdk::game::lua_catalog::GameLuaBridgeCommand
pub struct GameLuaBridgeCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| entity_arguments | Vec<usize> | |
Source: crates/platinum-sdk/src/game/lua_catalog.rs:353
platinum_sdk::game::lua_catalog::game_lua_bridge_catalog
pub fn game_lua_bridge_catalog() -> GameLuaBridgeCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_catalog.rs:357
platinum_sdk::game::bootstrap
platinum_sdk::game::bootstrap
Native SidecarV1 Game Host and compiler-free packaging CLI.
One admitted archive supplies both backend project reads and lazy Bevy assets.
No eager asset extraction/cache or all-payload compatibility scan is needed.
Source: crates/platinum-sdk/src/game/bootstrap.rs:1
platinum_sdk::game::bootstrap::host_requirements
pub fn host_requirements() -> HostRequirements
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/bootstrap.rs:18
platinum_sdk::game::bootstrap::GamePackageTrust
pub trait GamePackageTrust
Production runtime supplies its actual Auth/registry verifier. The local
development CLI below never claims unsigned packages authenticate publishers.
Source: crates/platinum-sdk/src/game/bootstrap.rs:35
platinum_sdk::game::bootstrap::PreparedGamePackage
pub struct PreparedGamePackage
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| root | PathBuf | |
| metadata | LaunchSidecarV1 | |
| assets | super::package_assets::PackageAssetReader | |
| presentation | ApplicationPresentationV1 | |
Source: crates/platinum-sdk/src/game/bootstrap.rs:38
platinum_sdk::game::bootstrap::prepare_package
pub fn prepare_package(
bundle: std::sync::Arc<NativePackageInput>,
trust: &dyn GamePackageTrust,
crypto: Option<std::sync::Arc<dyn PackageProtection + Send + Sync>>,
limits: &PackageLimits,
) -> PackageResult<PreparedGamePackage>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/bootstrap.rs:73
platinum_sdk::game::bootstrap::application
pub fn application(mut prepared: PreparedGamePackage) -> Result<App, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/bootstrap.rs:113
platinum_sdk::game::bootstrap::run_cli
pub fn run_cli() -> PackageResult<()>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/bootstrap.rs:173
platinum_sdk::game::bootstrap::ApplicationRuntimeIdentity
pub struct ApplicationRuntimeIdentity
Validated data visible to native application systems. Product identity and
authored presentation are not authenticated publisher/admission evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| application_id | ApplicationGuid | |
| title | String | |
| author | String | |
| display_version | Option<String> | |
| icon_asset | Option<String> | |
Source: crates/platinum-sdk/src/game/bootstrap_presentation.rs:9
platinum_sdk::game::bootstrap::validate_source_presentation
pub fn validate_source_presentation(
input: &NativePackageInput,
inventory: &[SourceAsset],
) -> PackageResult<ApplicationPresentationV1>
Host-side source validation after inventory capture. The shared streaming
exporter subsequently rechecks the same inventory hashes while packaging.
Source: crates/platinum-sdk/src/game/bootstrap_presentation.rs:54
platinum_sdk::game::bootstrap_web_export
platinum_sdk::game::bootstrap_web_export
Native compiler-free projection for the existing browser Game host. This
eagerly publishes HTTP assets/text from the SAME completed `.pla`; it is not
an in-browser ZIP reader, lazy mount, signer or protected-data bypass.
Source: crates/platinum-sdk/src/game/bootstrap_web_export.rs:1
platinum_sdk::game::bootstrap_web_export::template_receipt
pub fn template_receipt(
root: &NativePackageInput,
requirements: HostRequirements,
) -> PackageResult<BootstrapTemplateReceipt>
The prebuilt producer supplies its actual build requirements. Binary hashes
cannot infer a compiler ABI or authenticate that producer. Development CLI
admission remains explicitly development-only; production uses real trust.
Source: crates/platinum-sdk/src/game/bootstrap_web_export.rs:13
platinum_sdk::game::bootstrap_web_export::GameBrowserProjection
pub struct GameBrowserProjection
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/bootstrap_web_export.rs:116
platinum_sdk::game::package_assets
platinum_sdk::game::package_assets
Native lazy `.pla` Bevy source. Register before AssetPlugin/DefaultPlugins.
Disk/codec/crypto work runs on bounded workers, never inside poll_read.
Source: crates/platinum-sdk/src/game/package_assets.rs:1
platinum_sdk::game::package_assets::PackageAssetPoolConfig
pub struct PackageAssetPoolConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| workers | usize | |
| queued_chunks | usize | |
| active_readers | usize | |
| pending_waiters | usize | |
| maximum_asset_bytes | u64 | |
| maximum_resident_chunk_bytes | u64 | |
Source: crates/platinum-sdk/src/game/package_assets.rs:34
platinum_sdk::game::package_assets::PackageAssetStats
pub struct PackageAssetStats
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| active_readers | usize | |
| queued_chunks | usize | |
| completed_chunks | u64 | |
| decoded_bytes | u64 | |
Source: crates/platinum-sdk/src/game/package_assets.rs:77
platinum_sdk::game::package_assets::PackageAssetReader
pub struct PackageAssetReader
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/package_assets.rs:200
platinum_sdk::game::package_assets::PackageAssetReader::open_verified
pub fn open_verified(
root: Arc<NativePackageInput>,
expected_sha256: &str,
crypto: Option<SharedProtection>,
limits: PackageLimits,
config: PackageAssetPoolConfig,
) -> PackageResult<Self>
Blocking mount verification belongs on the backend/bootstrap lane before
UI activation. This verifies the archive SHA once and retains no-write/
no-delete handles. Each worker then opens its own independently seekable
archive, avoiding an archive mutex around decompression/crypto.
Source: crates/platinum-sdk/src/game/package_assets.rs:209
platinum_sdk::game::package_assets::PackageAssetReader::manifest
pub fn manifest(&self) -> &ApplicationManifest
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/package_assets.rs:378
platinum_sdk::game::package_assets::PackageAssetReader::read_blocking_range
pub fn read_blocking_range(
&self,
path: &str,
offset: u64,
bytes: u64,
) -> PackageResult<Vec<u8>>
Synchronous convenience for backend logic/startup lanes only. Rendering
and thumbnail UI must use async reads or their existing worker lane.
Uses the same closed archive and bounded workers, with explicit timeout.
Source: crates/platinum-sdk/src/game/package_assets.rs:384
platinum_sdk::game::package_assets::PackageAssetReader::stats
pub fn stats(&self) -> PackageAssetStats
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/package_assets.rs:453
platinum_sdk::game::package_assets::PackageAssetReader::source_builder
pub fn source_builder(&self) -> AssetSourceBuilder
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/package_assets.rs:462
platinum_sdk::game::package_assets::PackageAssetReader::register_default
pub fn register_default(&self, app: &mut App)
Must be called before AssetPlugin. No disk/render side effects occur here.
Source: crates/platinum-sdk/src/game/package_assets.rs:467
platinum_sdk::game::package_assets::PackageStreamReader
pub struct PackageStreamReader
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/package_assets.rs:567
platinum_sdk::game::package_project
platinum_sdk::game::package_project
Readonly backend view over the same admitted archive as the Bevy source.
Source: crates/platinum-sdk/src/game/package_project.rs:1
platinum_sdk::game::package_project::mount_package_project
pub fn mount_package_project(
reader: PackageAssetReader,
limits: &PackageLimits,
) -> PackageResult<MountedContent>
Mount IDs are process-local path compatibility tokens. Cross-process worlds
bind their own view to the same product/package identity, never reuse tokens.
Source: crates/platinum-sdk/src/game/package_project.rs:52
platinum_sdk::game::ScopedLuaCommand
pub struct ScopedLuaCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| player | u64 | |
| actor | u64 | |
| command | LuaCommand | |
Source: crates/platinum-sdk/src/game/scripting_web.rs:20
platinum_sdk::game::LuaHost
pub struct LuaHost
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| errors | Vec<String> | |
| calls | u64 | |
Source: crates/platinum-sdk/src/game/scripting_web.rs:25
platinum_sdk::game::LuaHost::new
pub fn new(root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:40
platinum_sdk::game::LuaHost::check
pub fn check(source: &str, name: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:59
platinum_sdk::game::LuaHost::set_game_state
pub fn set_game_state(&mut self, values: &BTreeMap<String, serde_json::Value>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:62
platinum_sdk::game::LuaHost::sync_scene_data
pub fn sync_scene_data(&mut self, data: SceneQueryData)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:67
platinum_sdk::game::LuaHost::suspend
pub fn suspend(&mut self, id: u64, suspended: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:72
platinum_sdk::game::LuaHost::has_actor
pub fn has_actor(&self, id: u64) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:79
platinum_sdk::game::LuaHost::install
pub fn install(&mut self, o: &SceneObject) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:82
platinum_sdk::game::LuaHost::sync_properties
pub fn sync_properties(&mut self, o: &SceneObject)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:96
platinum_sdk::game::LuaHost::sync_player
pub fn sync_player(
&mut self,
id: u64,
inventory: &[u64],
equipped: Option<u64>,
grounded: bool,
position: Vec3,
velocity: Vec3,
)
Refresh engine-owned read-only player state without restarting the script.
Source: crates/platinum-sdk/src/game/scripting_web.rs:102
platinum_sdk::game::LuaHost::sync_ui_state
pub fn sync_ui_state(&mut self, source: u64, revision: u64, view: &ui::UiQueryView)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:122
platinum_sdk::game::LuaHost::sync_health
pub fn sync_health(&mut self, id: u64, health: f32, max_health: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:137
platinum_sdk::game::LuaHost::game_event
pub fn game_event(&mut self, id: u64, event: &super::GameEvent)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:154
platinum_sdk::game::LuaHost::ui_event
pub fn ui_event(&mut self, id: u64, action: &str, value: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:171
platinum_sdk::game::LuaHost::update
pub fn update(&mut self, id: u64, dt: f32, i: GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:202
platinum_sdk::game::LuaHost::has_callback
pub fn has_callback(&self, id: u64, name: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:205
platinum_sdk::game::LuaHost::hit
pub fn hit(&mut self, id: u64, damage: f32, shooter: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:210
platinum_sdk::game::LuaHost::pickup
pub fn pickup(&mut self, id: u64, player: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:213
platinum_sdk::game::LuaHost::gear_event
pub fn gear_event(&mut self, id: u64, name: &str, player: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:216
platinum_sdk::game::LuaHost::fixed_update
pub fn fixed_update(&mut self, id: u64, tick: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:219
platinum_sdk::game::LuaHost::sync_physics
pub fn sync_physics(&mut self, id: u64, b: &PhysicsBodyState)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:222
platinum_sdk::game::LuaHost::contact
pub fn contact(&mut self, id: u64, other: u64, e: &PhysicsContact, n: Vec3)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:229
platinum_sdk::game::LuaHost::remove
pub fn remove(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:236
platinum_sdk::game::LuaHost::set_execution_owner
pub fn set_execution_owner(&mut self, player: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:242
platinum_sdk::game::LuaHost::drain
pub fn drain(&mut self) -> Vec<LuaCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:249
platinum_sdk::game::LuaHost::drain_scoped
pub fn drain_scoped(&mut self) -> Vec<ScopedLuaCommand>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scripting_web.rs:255
platinum_sdk::game::resolve_project_path
pub fn resolve_project_path(root: &Path, relative: &str) -> Result<PathBuf, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:8
platinum_sdk::game::GameInput
pub struct GameInput
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| forward | f32 | |
| right | f32 | |
| jump | bool | |
| interact | bool | |
| fire | bool | |
| fire_held | bool | |
| reload | bool | |
| sprint | bool | |
| tactical_sprint | bool | |
| direction_keys | u8 | W=1, S=2, A=4, D=8. Zero falls back to axes for scripts. |
| crouch | bool | |
| look | Vec2 | |
| slot | Option<usize> | |
| next_level | bool | |
| spawn_asset | bool | |
| event_spawn | bool | |
Source: crates/platinum-sdk/src/game/simulation.rs:33
platinum_sdk::game::PlayerPawn
pub struct PlayerPawn
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| health | f32 | |
| max_health | f32 | |
| source | u64 | |
| velocity | Vec3 | |
| grounded | bool | |
| crouched | bool | |
| sprinting | bool | |
| locomotion | SprintState | |
| weapon | Option<u64> | |
| inventory | Vec<u64> | |
| equipment | EquipmentState | |
| facing | character::CharacterFacing | |
Source: crates/platinum-sdk/src/game/simulation.rs:57
platinum_sdk::game::TargetState
pub struct TargetState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| health | f32 | |
| alive | bool | |
| respawn_at | f32 | |
Source: crates/platinum-sdk/src/game/simulation.rs:72
platinum_sdk::game::ShotTrace
pub struct ShotTrace
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| sequence | u32 | |
| normal | Vec3 | |
| surface | bool | |
| from | Vec3 | |
| to | Vec3 | |
| expires | f32 | |
| hit | bool | |
Source: crates/platinum-sdk/src/game/simulation.rs:78
platinum_sdk::game::FpsSession
pub struct FpsSession
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| streams | SceneStreams | |
| tick | SimulationTick | |
| cues | Vec<WorldCue> | |
| character_commands | Vec<super::character::CharacterCommand> | |
| character_facing_settings | character::CharacterFacingSettings | |
| character_replication | super::character::CharacterReplicationState | |
| sound_requests | Vec<super::audio::SoundCue> | |
| sound_cues | Vec<super::audio::SoundCue> | |
| shot_history | super::ShotHistory | |
| presentation_transforms | std::collections::BTreeMap<u64, Transform> | Client-only render transforms; collision/authority scene data stays untouched. |
| local_player | PlayerId | |
| dedicated | bool | |
| game | GameState | |
| combat | CombatMatch | |
| project | GameProject | |
| level_request | Option<LevelRequest> | |
| scene | SceneDocument | |
| presentation | Presentation | |
| player | PlayerPawn | |
| position | Vec3 | |
| yaw | f32 | |
| pitch | f32 | |
| score | i32 | |
| shots | u32 | |
| hits | u32 | |
| respawns | u32 | |
| elapsed | f32 | |
| paused | bool | |
| third_person | bool | |
| targets | HashMap<u64, TargetState> | |
| hidden | HashSet<u64> | |
| beacon_angles | HashMap<u64, f32> | |
| trace | Option<ShotTrace> | |
| message | String | |
| message_until | f32 | |
| lua | LuaHost | |
| events | EventTable | |
| event_scopes | EventScopes | |
| event_log | Vec<GameEvent> | |
| animations | Vec<AnimationPlayback> | |
| jolt | JoltWorld | |
| particle_requests | Vec<ParticleRequest> | |
| ui_requests | Vec<super::ui::UiRequest> | |
| ui_state | super::ui::UiState | |
| particle_cues | Vec<ParticleCue> | |
| explosions | u32 | |
Source: crates/platinum-sdk/src/game/simulation.rs:87
platinum_sdk::game::FpsSession::start
pub fn start(scene: SceneDocument, root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:161
platinum_sdk::game::FpsSession::spawn_asset
pub fn spawn_asset(
&mut self,
path: &str,
placement: AssetPlacement,
) -> Result<Vec<u64>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:382
platinum_sdk::game::FpsSession::set_game_phase
pub fn set_game_phase(&mut self, phase: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:439
platinum_sdk::game::FpsSession::load_level
pub fn load_level(&mut self, level: &str, preserve_score: bool) -> Result<(), String>
Transactional replacement: scripts, prefabs and player validation finish before swapping.
Source: crates/platinum-sdk/src/game/simulation.rs:451
platinum_sdk::game::FpsSession::from_project
pub fn from_project(root: &Path, level: Option<&str>) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:508
platinum_sdk::game::FpsSession::controller
pub fn controller(&self) -> PlayerController
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:516
platinum_sdk::game::FpsSession::movement_controller
pub fn movement_controller(&self) -> PlayerController
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:524
platinum_sdk::game::FpsSession::eye
pub fn eye(&self) -> Vec3
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:534
platinum_sdk::game::FpsSession::forward
pub fn forward(&self) -> Vec3
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:539
platinum_sdk::game::FpsSession::camera_transform
pub fn camera_transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:542
platinum_sdk::game::FpsSession::base_camera_transform
pub fn base_camera_transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:596
platinum_sdk::game::FpsSession::view_eye
pub fn view_eye(&self) -> Vec3
Bounded kinematic neck/face anchor. Physical head impulses never feed this
position. A short sweep keeps the look-down lean outside solid walls.
Source: crates/platinum-sdk/src/game/simulation.rs:601
platinum_sdk::game::FpsSession::weapon_muzzle_local
pub fn weapon_muzzle_local(&self) -> Vec3
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:657
platinum_sdk::game::FpsSession::weapon_muzzle
pub fn weapon_muzzle(&self) -> Vec3
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:671
platinum_sdk::game::FpsSession::held_weapon_transform
pub fn held_weapon_transform(&self) -> Transform
Shared socket-derived presentation/FX origin for true first person and TPS.
Gameplay aim continues to come from the stable controller camera.
Source: crates/platinum-sdk/src/game/simulation.rs:677
platinum_sdk::game::FpsSession::aim_at
pub fn aim_at(&mut self, point: Vec3)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:697
platinum_sdk::game::FpsSession::refresh_components
pub fn refresh_components(&mut self, mut objects: Vec<SceneObject>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:702
platinum_sdk::game::FpsSession::reload_scripts
pub fn reload_scripts(&mut self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:720
platinum_sdk::game::FpsSession::notify
pub fn notify(&mut self, s: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:748
platinum_sdk::game::FpsSession::step
pub fn step(&mut self, dt: f32, input: GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:778
platinum_sdk::game::FpsSession::switch_weapon
pub fn switch_weapon(&mut self, slot: usize)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:1401
platinum_sdk::game::FpsSession::play_animation
pub fn play_animation(
&mut self,
path: &str,
bindings: std::collections::BTreeMap<String, u64>,
inputs: AnimationInputs,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:1420
platinum_sdk::game::FpsSession::stop_object_animations
pub fn stop_object_animations(&mut self, object: u64)
Release transform-track ownership and remove clip-owned spawned objects.
Source: crates/platinum-sdk/src/game/simulation.rs:1429
platinum_sdk::game::FpsSession::play_animation_with_options
pub fn play_animation_with_options(
&mut self,
path: &str,
bindings: std::collections::BTreeMap<String, u64>,
inputs: AnimationInputs,
options: AnimationPlaybackOptions,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:1470
platinum_sdk::game::FpsSession::emit
pub fn emit(&mut self, mut event: GameEvent)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:1539
platinum_sdk::game::FpsSession::request_particles
pub fn request_particles(
&mut self,
path: &str,
position: Vec3,
rotation: Quat,
scale: f32,
duration: f32,
key: Option<u64>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:2351
platinum_sdk::game::FpsSession::explode
pub fn explode(&mut self, id: u64, radius: f32, damage: f32, impulse: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:2456
platinum_sdk::game::FpsSession::pickup_prompt
pub fn pickup_prompt(&self) -> Option<String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:2881
platinum_sdk::game::ground_height
pub fn ground_height(x: f32, z: f32, objects: &[SceneObject]) -> Option<f32>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:2916
platinum_sdk::game::ray_box
pub fn ray_box(origin: Vec3, direction: Vec3, min: Vec3, max: Vec3) -> Option<f32>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/simulation.rs:2981
platinum_sdk::game::world
platinum_sdk::game::world
Platform-neutral authority contracts. IDs remain integers through scripting and the wire.
Source: crates/platinum-sdk/src/game/world.rs:1
platinum_sdk::game::world::GAME_PROTOCOL_VERSION
pub const GAME_PROTOCOL_VERSION: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:7
platinum_sdk::game::world::GAME_TICK_SECONDS
pub const GAME_TICK_SECONDS: f64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:8
platinum_sdk::game::world::PlayerId
pub struct PlayerId(pub u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:10
platinum_sdk::game::world::SimulationTick
pub struct SimulationTick(pub u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:12
platinum_sdk::game::world::NetEntityId
pub struct NetEntityId
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| epoch | u64 | |
| id | u64 | |
| generation | u32 | |
Source: crates/platinum-sdk/src/game/world.rs:14
platinum_sdk::game::world::CueId
pub struct CueId
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| epoch | u64 | |
| tick | u64 | |
| sequence | u32 | |
Source: crates/platinum-sdk/src/game/world.rs:20
platinum_sdk::game::world::WorldCue
pub struct WorldCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| context | EventContext | |
| id | CueId | |
| name | String | |
| source | u64 | |
| player | PlayerId | |
| position | [f32; 3] | |
| inputs | AnimationInputs | |
Source: crates/platinum-sdk/src/game/world.rs:26
platinum_sdk::game::world::UiCue
pub struct UiCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | CueId | |
| request | super::ui::UiRequest | |
Source: crates/platinum-sdk/src/game/world.rs:37
platinum_sdk::game::world::ExecutionSide
pub enum ExecutionSide
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:42
platinum_sdk::game::world::FrameworkDefaults
pub struct FrameworkDefaults
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| controller | bool | |
| equipment | bool | |
| hotbar | bool | |
| crosshair | bool | |
| inventory_capacity | usize | |
| max_players | usize | |
| pickup_radius | f32 | |
| respawn_below | f32 | |
| main_menu | Option<String> | |
| launch_menu | Option<String> | |
| hud | Option<String> | |
| pause_menu | Option<String> | |
| lobby | Option<String> | |
| settings | Option<String> | |
| results_menu | Option<String> | |
| audio_manifest | Option<String> | |
| audio_mapping | Option<String> | |
| player_character | Option<String> | |
| first_person_character | Option<String> | |
| true_first_person | bool | Render the local character at its world-space feet, with shared gear and IK.
The first-person profile should omit camera-intersecting head geometry. |
Source: crates/platinum-sdk/src/game/world.rs:49
platinum_sdk::game::world::FrameworkDefaults::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world.rs:100
platinum_sdk::game::world::PlayerState
pub struct PlayerState
Per-player controller state; assets/world/Lua/Jolt are shared by the authority.
Public data fields| Name | Type / declaration | Description |
|---|
| id | PlayerId | |
| pawn | PlayerPawn | |
| position | Vec3 | |
| yaw | f32 | |
| pitch | f32 | |
| score | i32 | |
| shots | u32 | |
| hits | u32 | |
| respawns | u32 | |
| presentation | Presentation | |
| trace | Option<ShotTrace> | |
Source: crates/platinum-sdk/src/game/world.rs:131
platinum_sdk::game::world::PlayerSnapshot
pub struct PlayerSnapshot
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| health | f32 | |
| max_health | f32 | |
| id | PlayerId | |
| entity | NetEntityId | |
| position | [f32; 3] | |
| velocity | [f32; 3] | |
| yaw | f32 | |
| pitch | f32 | |
| grounded | bool | |
| crouched | bool | |
| sprinting | bool | |
| locomotion | SprintState | |
| inventory | Vec<u64> | |
| equipment | EquipmentState | |
| facing | character::CharacterFacing | |
| equipped | Option<u64> | |
| score | i32 | |
| shots | u32 | |
| hits | u32 | |
| respawns | u32 | |
| trace | Option<ShotTrace> | |
Source: crates/platinum-sdk/src/game/world.rs:149
platinum_sdk::game::world::WorldSnapshot
pub struct WorldSnapshot
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| streams | SceneStreams | |
| streaming | SceneStreamingConfig | |
| protocol | u32 | |
| tick | SimulationTick | |
| elapsed | f32 | |
| epoch | u64 | |
| level | String | |
| phase | GamePhase | |
| combat | CombatMatch | |
| values | BTreeMap<String, serde_json::Value> | |
| players | Vec<PlayerSnapshot> | |
| hidden | Vec<u64> | |
| objects | Vec<SceneObject> | |
| cues | Vec<WorldCue> | |
| characters | super::character::CharacterReplicationState | |
| particles | Vec<ParticleCue> | |
| sounds | Vec<super::audio::SoundCue> | |
| ui | Vec<UiCue> | |
| ui_state | BTreeMap<u64, super::ui::UiPlayerState> | |
Source: crates/platinum-sdk/src/game/world.rs:178
platinum_sdk::game::world_session
platinum_sdk::game::world_session
Renderer-neutral display projection contracts. This is not an ECS/VM checkpoint.
Transport authentication supplies `ProjectionAccess`; packet identities never grant access.
Source: crates/platinum-sdk/src/game/world_session.rs:1
platinum_sdk::game::world_session::WORLD_SESSION_VERSION
pub const WORLD_SESSION_VERSION: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:8
platinum_sdk::game::world_session::ExactU64
pub struct ExactU64(pub u64)
Canonical decimal strings preserve all 64 bits through JavaScript and JSON map keys.
Source: crates/platinum-sdk/src/game/world_session.rs:12
platinum_sdk::game::world_session::WorldIdentity
pub struct WorldIdentity
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| session | String | |
| world | String | |
Source: crates/platinum-sdk/src/game/world_session.rs:36
platinum_sdk::game::world_session::EntityKey
pub struct EntityKey
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | ExactU64 | |
| generation | u32 | |
Source: crates/platinum-sdk/src/game/world_session.rs:42
platinum_sdk::game::world_session::WorldHeader
pub struct WorldHeader
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| protocol | u32 | |
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| sequence | ExactU64 | |
| tick | ExactU64 | |
| runtime_fingerprint | String | |
Source: crates/platinum-sdk/src/game/world_session.rs:48
platinum_sdk::game::world_session::ProjectionConsistency
pub enum ProjectionConsistency
An exact cut is all registered display state at `header.tick`.
Interest snapshots explicitly retain individually aged entity samples.
Source: crates/platinum-sdk/src/game/world_session.rs:61
platinum_sdk::game::world_session::WorldComponent
pub struct WorldComponent
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| schema_version | u32 | |
| fields | BTreeMap<String, Value> | |
Source: crates/platinum-sdk/src/game/world_session.rs:68
platinum_sdk::game::world_session::WorldEntity
pub struct WorldEntity
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| key | EntityKey | |
| scene | String | |
| sample_tick | ExactU64 | Last explicit update; use WorldProjectionState::effective_sample_tick for ExactCut. |
| components | BTreeMap<String, WorldComponent> | |
Source: crates/platinum-sdk/src/game/world_session.rs:74
platinum_sdk::game::world_session::AssetDependency
pub struct AssetDependency
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset | String | |
| revision | ExactU64 | |
| digest | String | |
Source: crates/platinum-sdk/src/game/world_session.rs:83
platinum_sdk::game::world_session::WorldBaseline
pub struct WorldBaseline
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| baseline | ExactU64 | |
| revision | ExactU64 | |
| consistency | ProjectionConsistency | |
| dependencies | Vec<AssetDependency> | |
| entities | Vec<WorldEntity> | |
| tombstones | BTreeMap<ExactU64, u32> | Highest removed incarnation by ID, retained until the epoch changes. |
Source: crates/platinum-sdk/src/game/world_session.rs:90
platinum_sdk::game::world_session::WorldDeltaOp
pub enum WorldDeltaOp
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:101
platinum_sdk::game::world_session::WorldDelta
pub struct WorldDelta
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| baseline | ExactU64 | |
| from_revision | ExactU64 | |
| to_revision | ExactU64 | |
| dependencies | Vec<AssetDependency> | |
| operations | Vec<WorldDeltaOp> | |
Source: crates/platinum-sdk/src/game/world_session.rs:144
platinum_sdk::game::world_session::WorldProjectionPayload
pub enum WorldProjectionPayload
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:158
platinum_sdk::game::world_session::WorldProjectionPacket
pub struct WorldProjectionPacket
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| header | WorldHeader | |
| payload | WorldProjectionPayload | |
Source: crates/platinum-sdk/src/game/world_session.rs:164
platinum_sdk::game::world_session::ProjectionAck
pub struct ProjectionAck
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| sequence | ExactU64 | |
| baseline | ExactU64 | |
| revision | ExactU64 | |
Source: crates/platinum-sdk/src/game/world_session.rs:170
platinum_sdk::game::world_session::FieldType
pub enum FieldType
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:179
platinum_sdk::game::world_session::WorldComponentSchema
pub struct WorldComponentSchema
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| fields | BTreeMap<String, FieldType> | |
| required | BTreeSet<String> | |
Source: crates/platinum-sdk/src/game/world_session.rs:188
platinum_sdk::game::world_session::ProjectionLimits
pub struct ProjectionLimits
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| packet_bytes | usize | |
| state_bytes | usize | |
| entities | usize | |
| tombstones | usize | |
| operations | usize | |
| components_per_entity | usize | |
| fields_per_component | usize | |
| value_bytes | usize | |
| value_nodes | usize | |
| value_depth | usize | |
Source: crates/platinum-sdk/src/game/world_session.rs:194
platinum_sdk::game::world_session::ProjectionAccess
pub struct ProjectionAccess
Supplied by the trusted host after capability validation. Exact epoch pinning
means a packet cannot grant itself authority by claiming a newer epoch.
Public data fields| Name | Type / declaration | Description |
|---|
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| runtime_fingerprint | String | |
| available_assets | BTreeMap<String, (ExactU64, String)> | |
Source: crates/platinum-sdk/src/game/world_session.rs:226
platinum_sdk::game::world_session::WorldProjectionState
pub struct WorldProjectionState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| header | WorldHeader | |
| baseline | ExactU64 | |
| revision | ExactU64 | |
| consistency | ProjectionConsistency | |
| entities | BTreeMap<ExactU64, WorldEntity> | |
| tombstones | BTreeMap<ExactU64, u32> | |
| incarnations | BTreeMap<ExactU64, u32> | Highest observed incarnation, retained across interest eviction until epoch reset. |
| dependencies | BTreeMap<String, (ExactU64, String)> | |
Source: crates/platinum-sdk/src/game/world_session.rs:233
platinum_sdk::game::world_session::WorldProjectionState::effective_sample_tick
pub fn effective_sample_tick(&self, entity: &WorldEntity) -> ExactU64
Exact cuts assert unchanged values at the header tick without rewriting
every entity. Interest samples retain their independently observed age.
Source: crates/platinum-sdk/src/game/world_session.rs:247
platinum_sdk::game::world_session::ProjectionApplyWork
pub struct ProjectionApplyWork
Work for the last accepted publication; counts actual staged record clones
and retained entity encodings, excluding bounded incoming-packet preflight.
Public data fields| Name | Type / declaration | Description |
|---|
| cloned_entities | usize | |
| validated_entities | usize | |
| encoded_entities | usize | |
| dependency_checks | usize | |
| baseline_entities | usize | |
Source: crates/platinum-sdk/src/game/world_session.rs:257
platinum_sdk::game::world_session::WorldProjectionStore
pub struct WorldProjectionStore
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:324
platinum_sdk::game::world_session::WorldProjectionStore::new
pub fn new(limits: ProjectionLimits) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:332
platinum_sdk::game::world_session::WorldProjectionStore::register_schema
pub fn register_schema(
&mut self,
name: String,
schema: WorldComponentSchema,
) -> Result<(), String>
Register schemas before attaching. Schema changes require a fresh store/baseline.
Source: crates/platinum-sdk/src/game/world_session.rs:342
platinum_sdk::game::world_session::WorldProjectionStore::state
pub fn state(&self) -> Option<&WorldProjectionState>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:363
platinum_sdk::game::world_session::WorldProjectionStore::last_apply_work
pub fn last_apply_work(&self) -> ProjectionApplyWork
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:366
platinum_sdk::game::world_session::WorldProjectionStore::apply_json
pub fn apply_json(
&mut self,
bytes: &[u8],
access: &ProjectionAccess,
) -> Result<ProjectionAck, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:369
platinum_sdk::game::world_session::WorldProjectionStore::apply
pub fn apply(
&mut self,
packet: WorldProjectionPacket,
access: &ProjectionAccess,
) -> Result<ProjectionAck, String>
Applies a complete publication cut atomically; any failure leaves the old state untouched.
Deltas stage only touched records; baselines validate the complete replacement.
Source: crates/platinum-sdk/src/game/world_session.rs:384
platinum_sdk::game::world_session::WorldAuthorityAllocator
pub struct WorldAuthorityAllocator
IDs are minted only in an explicitly provisioned authority epoch, never inferred
by scanning received objects. Restart/transfer uses a new fenced epoch.
Source: crates/platinum-sdk/src/game/world_session.rs:1129
platinum_sdk::game::world_session::WorldAuthorityAllocator::new
pub fn new(identity: WorldIdentity, epoch: ExactU64) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1135
platinum_sdk::game::world_session::WorldAuthorityAllocator::identity
pub fn identity(&self) -> &WorldIdentity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1146
platinum_sdk::game::world_session::WorldAuthorityAllocator::epoch
pub fn epoch(&self) -> ExactU64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1149
platinum_sdk::game::world_session::WorldAuthorityAllocator::allocate
pub fn allocate(&mut self) -> Result<EntityKey, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1152
platinum_sdk::game::world_session::WorldOccurrenceId
pub struct WorldOccurrenceId
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| epoch | ExactU64 | |
| tick | ExactU64 | |
| sequence | u32 | |
Source: crates/platinum-sdk/src/game/world_session.rs:1167
platinum_sdk::game::world_session::OrderedWorldInjection
pub struct OrderedWorldInjection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | WorldOccurrenceId | |
| operation | String | |
| producer | String | |
| causal_command | String | |
| payload | Value | |
Source: crates/platinum-sdk/src/game/world_session.rs:1174
platinum_sdk::game::world_session::validate_injections
pub fn validate_injections(
events: &[OrderedWorldInjection],
epoch: ExactU64,
after: Option<&WorldOccurrenceId>,
limits: &ProjectionLimits,
) -> Result<(), String>
Validates an admitted log batch; authentication/ownership must precede admission.
Source: crates/platinum-sdk/src/game/world_session.rs:1182
platinum_sdk::game::world_session::CheckpointCoverage
pub enum CheckpointCoverage
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1219
platinum_sdk::game::world_session::WorldCheckpointDeclaration
pub struct WorldCheckpointDeclaration
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| runtime_fingerprint | String | |
| subsystems | BTreeMap<String, CheckpointCoverage> | |
Source: crates/platinum-sdk/src/game/world_session.rs:1227
platinum_sdk::game::world_session::WorldCheckpointDeclaration::require_continuation
pub fn require_continuation(
&self,
required: &BTreeSet<String>,
fingerprint: &str,
) -> Result<(), String>
A declaration is not checkpoint bytes or qualification evidence. The host
supplies the complete required subsystem list; omitted domains fail closed.
Source: crates/platinum-sdk/src/game/world_session.rs:1234
platinum_sdk::game::world_session::NetworkSimulationMode
pub enum NetworkSimulationMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:1989
platinum_sdk::game::world_session::DeterministicModule
pub struct DeterministicModule
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| digest | String | Qualified logical/behavior digest, not target-specific native binary bytes.
The runtime fingerprint separately pins those artifact/toolchain bytes. |
| qualified_profile | Option<String> | Populated only after the release qualification pipeline accepts the module. |
| gameplay | bool | |
Source: crates/platinum-sdk/src/game/world_session.rs:1995
platinum_sdk::game::world_session::WorldDeterminismManifest
pub struct WorldDeterminismManifest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| strict | bool | |
| profile | String | |
| runtime_fingerprint | String | |
| content_fingerprint | String | |
| target | String | |
| modules | Vec<DeterministicModule> | |
Source: crates/platinum-sdk/src/game/world_session.rs:2006
platinum_sdk::game::world_session::WorldDeterminismManifest::validate
pub fn validate(&self, mode: NetworkSimulationMode) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session.rs:2015
platinum_sdk::game::world_session::WorldDeterminismManifest::compatible_with
pub fn compatible_with(
&self,
peer: &Self,
mode: NetworkSimulationMode,
qualified_pairs: &BTreeSet<(String, String)>,
) -> Result<(), String>
`qualified_pairs` comes from trusted SDK qualification receipts, not peers.
Source: crates/platinum-sdk/src/game/world_session.rs:2042
platinum_sdk::game::live_view_adapter
platinum_sdk::game::live_view_adapter
Read-only common LiveView over an already validated WorldProjectionStore.
This is a small accepted-world summary projection, not serialization of the
simulation or a replacement for GameWorldView's entity/3D rendering path.
Source: crates/platinum-sdk/src/game/live_view_adapter.rs:1
platinum_sdk::game::live_view_adapter::WorldSummaryLiveView
pub struct WorldSummaryLiveView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/live_view_adapter.rs:18
platinum_sdk::game::live_view_adapter::WorldSummaryLiveView::from_store
pub fn from_store(
reference: DocumentRef,
store: &WorldProjectionStore,
) -> Result<Self, LiveViewError>
Trusted host supplies the already authorized accepted store. Incoming
packets must first pass WorldProjectionStore::apply/apply_json with the
actual authenticated ProjectionAccess; packet IDs are never grants.
Source: crates/platinum-sdk/src/game/live_view_adapter.rs:28
platinum_sdk::game::live_view_adapter::WorldSummaryLiveView::issue
pub fn issue(
&self,
allow_copy: bool,
) -> Result<(LiveViewHandle, LiveViewRevocation), LiveViewError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/live_view_adapter.rs:64
platinum_sdk::game::live_view_adapter::WorldSummaryLiveView::publish_from_store
pub fn publish_from_store(
&mut self,
store: &WorldProjectionStore,
) -> Result<Generation, LiveViewError>
Publish after the existing projection store accepts a new baseline/delta.
Same-tick cuts are allowed; sequence/epoch advancement is still required.
Source: crates/platinum-sdk/src/game/live_view_adapter.rs:72
platinum_sdk::game::world_session_game
platinum_sdk::game::world_session_game
Explicit dirty-ledger adapter from the current game authority to WorldProjection v1.
No world tick, script execution, physics step or transport is installed here.
Source: crates/platinum-sdk/src/game/world_session_game.rs:1
platinum_sdk::game::world_session_game::GAME_OBJECT_COMPONENT
pub const GAME_OBJECT_COMPONENT: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:9
platinum_sdk::game::world_session_game::GAME_PLAYER_COMPONENT
pub const GAME_PLAYER_COMPONENT: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:10
platinum_sdk::game::world_session_game::GAME_WORLD_COMPONENT
pub const GAME_WORLD_COMPONENT: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:11
platinum_sdk::game::world_session_game::register_game_projection_schemas
pub fn register_game_projection_schemas(store: &mut WorldProjectionStore) -> Result<(), String>
Compatibility DTOs stay JSON *text* at this boundary, preserving legacy nested
u64 fields when decoded in Rust/native/WASM. They are not parsed as JS numbers.
Source: crates/platinum-sdk/src/game/world_session_game.rs:15
platinum_sdk::game::world_session_game::GameDisplayExtras
pub struct GameDisplayExtras
Versioned display samples, never a solver/animation continuation checkpoint.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| beacon_speed | f32 | |
| presentation | crate::game::PresentationDisplay | |
| beacon_angles | BTreeMap<ExactU64, f32> | |
| bodies | BTreeMap<ExactU64, ProjectedBodySample> | |
Source: crates/platinum-sdk/src/game/world_session_game.rs:63
platinum_sdk::game::world_session_game::ProjectedBodySample
pub struct ProjectedBodySample
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| position | [f32; 3] | |
| rotation | [f32; 4] | |
| velocity | [f32; 3] | |
| angular_velocity | [f32; 3] | |
| active | bool | |
| tick | ExactU64 | |
Source: crates/platinum-sdk/src/game/world_session_game.rs:72
platinum_sdk::game::world_session_game::GameWorldMetadata
pub struct GameWorldMetadata
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| display | Option<GameDisplayExtras> | None means the source did not supply these samples (legacy protocol2 snapshot). |
| protocol | u32 | |
| tick | crate::game::SimulationTick | |
| elapsed | f32 | |
| epoch | u64 | |
| level | String | |
| phase | crate::game::GamePhase | |
| combat | crate::game::CombatMatch | |
| values | BTreeMap<String, Value> | |
| streams | crate::game::SceneStreams | |
| streaming | crate::game::SceneStreamingConfig | |
| cues | Vec<crate::game::WorldCue> | |
| characters | crate::game::character::CharacterReplicationState | |
| particles | Vec<crate::game::ParticleCue> | |
| sounds | Vec<crate::game::audio::SoundCue> | |
| ui | Vec<crate::game::UiCue> | |
| ui_state | BTreeMap<u64, crate::game::ui::UiPlayerState> | |
Source: crates/platinum-sdk/src/game/world_session_game.rs:82
platinum_sdk::game::world_session_game::GameWorldMetadata::from_snapshot
pub fn from_snapshot(snapshot: &WorldSnapshot) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:105
platinum_sdk::game::world_session_game::GameWorldMetadata::from_session
pub fn from_session(session: &FpsSession) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:126
platinum_sdk::game::world_session_game::GameProjectionPriority
pub enum GameProjectionPriority
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:189
platinum_sdk::game::world_session_game::GameProjectionDirty
pub struct GameProjectionDirty
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reindex_objects | bool | Reindex after structural changes/reordering; not needed for ordinary transforms. |
| objects | BTreeMap<u64, GameProjectionPriority> | |
| removed_objects | BTreeSet<u64> | |
| players | BTreeMap<u64, GameProjectionPriority> | |
| removed_players | BTreeSet<u64> | |
| metadata | bool | |
Source: crates/platinum-sdk/src/game/world_session_game.rs:196
platinum_sdk::game::world_session_game::GameProjectionBudget
pub struct GameProjectionBudget
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| entities_per_packet | usize | |
| packet_bytes | usize | |
| maximum_dirty_age_ticks | u64 | Deferred dirty entries receive highest priority once this age is reached. |
Source: crates/platinum-sdk/src/game/world_session_game.rs:206
platinum_sdk::game::world_session_game::GameProjectionProducer
pub struct GameProjectionProducer
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:249
platinum_sdk::game::world_session_game::GameProjectionProducer::new
pub fn new(
identity: WorldIdentity,
authority_epoch: ExactU64,
source_epoch: u64,
runtime_fingerprint: String,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:267
platinum_sdk::game::world_session_game::GameProjectionProducer::identity
pub fn identity(&self) -> &WorldIdentity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:294
platinum_sdk::game::world_session_game::GameProjectionProducer::epoch
pub fn epoch(&self) -> ExactU64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:297
platinum_sdk::game::world_session_game::GameProjectionProducer::set_dependencies
pub fn set_dependencies(&mut self, dependencies: Vec<AssetDependency>) -> Result<(), String>
Set before first publication. Asset changes later need a new negotiated producer epoch.
Source: crates/platinum-sdk/src/game/world_session_game.rs:301
platinum_sdk::game::world_session_game::GameProjectionProducer::upsert_object
pub fn upsert_object(
&mut self,
object: &SceneObject,
hidden: bool,
tick: u64,
priority: GameProjectionPriority,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:375
platinum_sdk::game::world_session_game::GameProjectionProducer::upsert_player
pub fn upsert_player(
&mut self,
player: &PlayerSnapshot,
tick: u64,
priority: GameProjectionPriority,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:407
platinum_sdk::game::world_session_game::GameProjectionProducer::upsert_metadata
pub fn upsert_metadata(&mut self, metadata: &GameWorldMetadata) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:431
platinum_sdk::game::world_session_game::GameProjectionProducer::remove_object
pub fn remove_object(&mut self, id: u64, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:475
platinum_sdk::game::world_session_game::GameProjectionProducer::remove_player
pub fn remove_player(&mut self, id: u64, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:479
platinum_sdk::game::world_session_game::GameProjectionProducer::capture_initial_session
pub fn capture_initial_session(&mut self, session: &FpsSession) -> Result<(), String>
One initial attach scan. Subsequent captures must supply a real mutation ledger.
Source: crates/platinum-sdk/src/game/world_session_game.rs:484
platinum_sdk::game::world_session_game::GameProjectionProducer::capture_session
pub fn capture_session(
&mut self,
session: &FpsSession,
dirty: &GameProjectionDirty,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:506
platinum_sdk::game::world_session_game::GameProjectionProducer::observe_session
pub fn observe_session(&mut self, session: &FpsSession) -> Result<(), String>
Compatibility bridge for a live, presently uninstrumented authority. Scans
borrowed objects for equality and copies only changes; does not call snapshot().
Run at publication cadence, not once per camera/render frame. Dirty hooks above
remove this O(objects) detection scan when integrated into all mutation paths.
Source: crates/platinum-sdk/src/game/world_session_game.rs:597
platinum_sdk::game::world_session_game::GameProjectionProducer::capture_snapshot
pub fn capture_snapshot(&mut self, snapshot: &WorldSnapshot) -> Result<(), String>
Compatibility ingress for an already-produced protocol-2 snapshot. This scans
all objects and serializes only changed ones; it is not the high-rate dirty hook.
Source: crates/platinum-sdk/src/game/world_session_game.rs:654
platinum_sdk::game::world_session_game::GameProjectionProducer::pending_packet
pub fn pending_packet(&self) -> Option<&WorldProjectionPacket>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:715
platinum_sdk::game::world_session_game::GameProjectionProducer::dirty_count
pub fn dirty_count(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:718
platinum_sdk::game::world_session_game::GameProjectionProducer::prepare
pub fn prepare(
&mut self,
tick: u64,
budget: &GameProjectionBudget,
) -> Result<Option<&WorldProjectionPacket>, String>
One outstanding publication; retry the same immutable packet until ACK/resync.
Budget deferral retains dirty generations, including edits made during a flight.
Source: crates/platinum-sdk/src/game/world_session_game.rs:723
platinum_sdk::game::world_session_game::GameProjectionProducer::acknowledge
pub fn acknowledge(&mut self, ack: &ProjectionAck) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_game.rs:872
platinum_sdk::game::world_session_view
platinum_sdk::game::world_session_view
Read-only Rust/Bevy presentation consumer for the current game projection adapter.
Installs no GameRuntime, Lua host, physics authority or gameplay systems.
Source: crates/platinum-sdk/src/game/world_session_view.rs:1
platinum_sdk::game::world_session_view::ProjectedWorldObject
pub struct ProjectedWorldObject
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| key | EntityKey | |
| source_id | u64 | |
| sample_tick | ExactU64 | Last explicit entity update. Use effective_sample_tick for exact cuts. |
Source: crates/platinum-sdk/src/game/world_session_view.rs:11
platinum_sdk::game::world_session_view::ProjectedWorldCut
pub struct ProjectedWorldCut
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| header | WorldHeader | |
| consistency | ProjectionConsistency | |
Source: crates/platinum-sdk/src/game/world_session_view.rs:18
platinum_sdk::game::world_session_view::ProjectedWorldObject::effective_sample_tick
pub fn effective_sample_tick(&self, cut: &ProjectedWorldCut) -> ExactU64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:23
platinum_sdk::game::world_session_view::ProjectedBodyMotion
pub struct ProjectedBodyMotion(pub ProjectedBodySample)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:32
platinum_sdk::game::world_session_view::ProjectedGameMetadata
pub struct ProjectedGameMetadata(pub GameWorldMetadata)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:34
platinum_sdk::game::world_session_view::GameWorldViewOptions
pub struct GameWorldViewOptions
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| player_profile | Option<String> | Optional project-supplied character profile; snapshot v2 does not contain it. |
| asset_root | String | |
Source: crates/platinum-sdk/src/game/world_session_view.rs:36
platinum_sdk::game::world_session_view::GameWorldView
pub struct GameWorldView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:52
platinum_sdk::game::world_session_view::GameWorldView::new
pub fn new(options: GameWorldViewOptions) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:62
platinum_sdk::game::world_session_view::GameWorldView::object_entity
pub fn object_entity(&self, source_id: u64) -> Option<Entity>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:80
platinum_sdk::game::world_session_view::GameWorldView::player
pub fn player(&self, player_id: u64) -> Option<&PlayerSnapshot>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:86
platinum_sdk::game::world_session_view::GameWorldView::take_character_commands
pub fn take_character_commands(&mut self) -> Vec<crate::game::character::CharacterCommand>
Only confirmed, deduplicated presentation commands. The host may hand these
to CharacterCommands; they must not award health/ammo/score or run gameplay.
Source: crates/platinum-sdk/src/game/world_session_view.rs:91
platinum_sdk::game::world_session_view::GameWorldView::last_ack
pub fn last_ack(&self) -> Option<&ProjectionAck>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_session_view.rs:94
platinum_sdk::game::world_session_view::GameWorldView::apply_accepted
pub fn apply_accepted(
&mut self,
packet: &WorldProjectionPacket,
store: &WorldProjectionStore,
world: &mut World,
) -> Result<(), String>
Call only after the projection store accepted this exact packet. Decoding and
domain checks finish before ECS mutation; untouched delta objects are not cloned.
Source: crates/platinum-sdk/src/game/world_session_view.rs:100
platinum_sdk::game::presentation_world
platinum_sdk::game::presentation_world
Shared read-only presentation source. A mirror contains DTOs and cosmetic state,
never a FpsSession, Lua VM, gameplay physics world or authority command executor.
Source: crates/platinum-sdk/src/game/presentation_world.rs:1
platinum_sdk::game::presentation_world::WorldPresentationSource
pub trait WorldPresentationSource
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:8
platinum_sdk::game::presentation_world::WorldPresentationFrame
pub struct WorldPresentationFrame<'a>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| game | &'a GameState | |
| scene | &'a SceneDocument | |
| project | &'a GameProject | |
| hidden | &'a HashSet<u64> | |
| streams | &'a SceneStreams | |
| cues | &'a [WorldCue] | |
| tick | SimulationTick | |
| elapsed | f32 | |
| paused | bool | |
| third_person | bool | |
| local_player | PlayerId | |
| presentation | &'a Presentation | |
Source: crates/platinum-sdk/src/game/presentation_world.rs:14
platinum_sdk::game::presentation_world::WorldPresentationFrame::player_ids
pub fn player_ids(&self) -> Vec<PlayerId>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:30
platinum_sdk::game::presentation_world::WorldPresentationFrame::player_state
pub fn player_state(&self, id: PlayerId) -> Option<PlayerState>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:33
platinum_sdk::game::presentation_world::WorldPresentationFrame::camera_transform
pub fn camera_transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:36
platinum_sdk::game::presentation_world::MirroredPresentation
pub struct MirroredPresentation
One read replica shared by all cameras. Only `GameWorldView` updates canonical
display DTOs; this resource may animate/smooth derived presentation locally.
Public data fields| Name | Type / declaration | Description |
|---|
| generation | u64 | |
| scene_revision | u64 | |
| display | Option<super::world_session_game::GameDisplayExtras> | |
| root | PathBuf | |
| project | GameProject | |
| scene | SceneDocument | |
| game | GameState | |
| hidden | HashSet<u64> | |
| streams | SceneStreams | |
| cues | Vec<WorldCue> | |
| tick | SimulationTick | |
| elapsed | f32 | |
| paused | bool | |
| local_player | PlayerId | |
| third_person | bool | |
| presentation | Presentation | |
| particle_requests | Vec<ParticleRequest> | |
| sound_requests | Vec<audio::SoundCue> | |
| last_audio_epoch | Option<u64> | |
Source: crates/platinum-sdk/src/game/presentation_world.rs:72
platinum_sdk::game::presentation_world::MirroredPresentation::new
pub fn new(root: &Path, local_player: PlayerId) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:100
platinum_sdk::game::presentation_world::MirroredPresentation::reset_projection
pub fn reset_projection(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:138
platinum_sdk::game::presentation_world::MirroredPresentation::upsert_object
pub fn upsert_object(&mut self, object: SceneObject, hidden: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:159
platinum_sdk::game::presentation_world::MirroredPresentation::remove_object
pub fn remove_object(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:174
platinum_sdk::game::presentation_world::MirroredPresentation::upsert_player
pub fn upsert_player(&mut self, player: PlayerSnapshot)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:184
platinum_sdk::game::presentation_world::MirroredPresentation::object
pub fn object(&self, id: u64) -> Option<&SceneObject>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:187
platinum_sdk::game::presentation_world::MirroredPresentation::equipped
pub fn equipped(&self, player: PlayerId) -> Option<u64>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:192
platinum_sdk::game::presentation_world::MirroredPresentation::retain_players
pub fn retain_players(&mut self, keep: &std::collections::BTreeSet<u64>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:195
platinum_sdk::game::presentation_world::MirroredPresentation::update_metadata
pub fn update_metadata(&mut self, metadata: &super::world_session_game::GameWorldMetadata)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:199
platinum_sdk::game::presentation_world::MirroredPresentation::advance_cosmetics
pub fn advance_cosmetics(&mut self, dt: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/presentation_world.rs:258
platinum_sdk::game::world_view_protocol
platinum_sdk::game::world_view_protocol
Bounded developer pipe protocol. Handles and launch trust come from the parent,
never from a localhost listener or a packet-supplied publisher identity.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:1
platinum_sdk::game::world_view_protocol::WORLD_VIEW_PIPE_VERSION
pub const WORLD_VIEW_PIPE_VERSION: u32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:8
platinum_sdk::game::world_view_protocol::MAX_WORLD_VIEW_FRAME
pub const MAX_WORLD_VIEW_FRAME: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:9
platinum_sdk::game::world_view_protocol::WorldViewGreeting
pub struct WorldViewGreeting
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| protocol | u32 | |
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| source_epoch | ExactU64 | |
| runtime_fingerprint | String | |
| local_player | ExactU64 | |
| player_profile | Option<String> | |
| asset_root | String | |
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:12
platinum_sdk::game::world_view_protocol::WorldViewClientPacket
pub enum WorldViewClientPacket
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:29
platinum_sdk::game::world_view_protocol::WorldViewServerPacket
pub enum WorldViewServerPacket
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:45
platinum_sdk::game::world_view_protocol::read_frame
pub fn read_frame<R: Read, T: serde::de::DeserializeOwned>(
reader: &mut R,
maximum: usize,
) -> Result<Option<T>, String>
A zero-byte read before a new length is clean EOF. Partial headers/bodies fail.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:62
platinum_sdk::game::world_view_protocol::write_frame
pub fn write_frame<W: Write, T: Serialize>(
writer: &mut W,
packet: &T,
maximum: usize,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:92
platinum_sdk::game::world_view_protocol::merge_game_input
pub fn merge_game_input(current: &mut GameInput, incoming: GameInput)
Coalesces replaceable held axes while preserving edge commands and look deltas
during a bounded queue stall. Never queues one heap allocation per render frame.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:135
platinum_sdk::game::world_view_protocol::clear_game_input_edges
pub fn clear_game_input_edges(input: &mut GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_protocol.rs:157
platinum_sdk::game::world_view_host
platinum_sdk::game::world_view_host
Explicitly trusted developer-only child-pipe host and authority runner.
No publisher admission, public network service or sandbox claim is made here.
Source: crates/platinum-sdk/src/game/world_view_host.rs:1
platinum_sdk::game::world_view_host::DeveloperWorldLaunch
pub struct DeveloperWorldLaunch
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| server_executable | PathBuf | |
| project | PathBuf | |
| level | Option<String> | |
| mode | String | |
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| runtime_fingerprint | String | |
Source: crates/platinum-sdk/src/game/world_view_host.rs:14
platinum_sdk::game::world_view_host::WorldViewHostEvent
pub enum WorldViewHostEvent
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:24
platinum_sdk::game::world_view_host::WorldViewChild
pub struct WorldViewChild
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:30
platinum_sdk::game::world_view_host::WorldViewChild::spawn
pub fn spawn(mut launch: DeveloperWorldLaunch) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:44
platinum_sdk::game::world_view_host::WorldViewChild::queue_input
pub fn queue_input(&mut self, input: GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:149
platinum_sdk::game::world_view_host::WorldViewChild::clear_input
pub fn clear_input(&mut self)
Focus/capture loss cancels unsent edges as well as held state.
Source: crates/platinum-sdk/src/game/world_view_host.rs:154
platinum_sdk::game::world_view_host::WorldViewChild::queue_ack
pub fn queue_ack(&mut self, ack: ProjectionAck) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:158
platinum_sdk::game::world_view_host::WorldViewChild::poll
pub fn poll(&mut self) -> Vec<WorldViewHostEvent>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:218
platinum_sdk::game::world_view_host::WorldViewChild::close
pub fn close(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_host.rs:275
platinum_sdk::game::world_view_host::DeveloperWorldServerConfig
pub struct DeveloperWorldServerConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| project | PathBuf | |
| level | Option<String> | |
| mode | String | |
| identity | WorldIdentity | |
| epoch | ExactU64 | |
| runtime_fingerprint | String | |
Source: crates/platinum-sdk/src/game/world_view_host.rs:296
platinum_sdk::game::world_view_host::run_developer_world_server
pub fn run_developer_world_server(config: DeveloperWorldServerConfig) -> Result<(), String>
Runs one actual authority. stdout is reserved for framed protocol bytes; logs go
to stderr. This caller must be an explicitly admitted developer child launch.
Source: crates/platinum-sdk/src/game/world_view_host.rs:311
platinum_sdk::game::world_view_presentation
platinum_sdk::game::world_view_presentation
Production presentation adapters for a read-only world view. No GameRuntime,
FpsSession, gameplay Lua or authoritative physics is created by this plugin.
Source: crates/platinum-sdk/src/game/world_view_presentation.rs:1
platinum_sdk::game::world_view_presentation::PipePresentationSet
pub enum PipePresentationSet
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_presentation.rs:10
platinum_sdk::game::world_view_presentation::PipePresentationPlugin
pub struct PipePresentationPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_presentation.rs:14
platinum_sdk::game::world_view_presentation::PipePresentationPlugin::new
pub fn new(root: &Path, output: bool) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/world_view_presentation.rs:19
platinum_sdk::game::MatchMode
pub enum MatchMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:8
platinum_sdk::game::MatchMode::parse
pub fn parse(name: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:16
platinum_sdk::game::MatchMode::label
pub fn label(self) -> &'static str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:25
platinum_sdk::game::MatchMode::teams
pub fn teams(self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:33
platinum_sdk::game::MatchSpawn
pub struct MatchSpawn
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| team | u8 | |
| position | [f32; 3] | |
| yaw | f32 | |
Source: crates/platinum-sdk/src/game/combat.rs:38
platinum_sdk::game::CombatConfig
pub struct CombatConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| respawn_seconds | f32 | |
| spawn_protection | f32 | |
| score_limit | u32 | |
| capture_limit | u32 | |
| spawns | Vec<MatchSpawn> | |
| flag_bases | [[f32; 3]; 2] | |
| loadout | Vec<String> | |
| flesh_particles | Option<String> | |
Source: crates/platinum-sdk/src/game/combat.rs:45
platinum_sdk::game::CombatConfig::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:70
platinum_sdk::game::HealthPickup
pub struct HealthPickup
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| amount | f32 | |
| radius | f32 | |
| respawn_seconds | f32 | |
Source: crates/platinum-sdk/src/game/combat.rs:99
platinum_sdk::game::Combatant
pub struct Combatant
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| loadout | Vec<u64> | |
| team | u8 | |
| kills | u32 | |
| deaths | u32 | |
| captures | u32 | |
| respawn_at | Option<f32> | |
| protected_until | f32 | |
Source: crates/platinum-sdk/src/game/combat.rs:114
platinum_sdk::game::FlagState
pub struct FlagState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| carrier | Option<PlayerId> | |
| dropped | Option<[f32; 3]> | |
| return_at | f32 | |
Source: crates/platinum-sdk/src/game/combat.rs:125
platinum_sdk::game::CombatMatch
pub struct CombatMatch
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| mode | MatchMode | |
| running | bool | |
| rules | Option<GameModeAsset> | |
| players | BTreeMap<u64, Combatant> | |
| team_scores | [u32; 2] | |
| flags | [FlagState; 2] | |
| winner | Option<String> | |
| pickups | BTreeMap<u64, f32> | |
Source: crates/platinum-sdk/src/game/combat.rs:131
platinum_sdk::game::CombatMatch::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/combat.rs:146
platinum_sdk::game::Gear
pub type Gear
Existing project files retain the `weapon_pickup` field for compatibility.
Source: crates/platinum-sdk/src/game/equipment.rs:5
platinum_sdk::game::EquipmentState
pub struct EquipmentState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| animation_pose | Option<EquipmentAnimationPose> | General object-animation bindings on a held item, replicated as a local
pose delta so each client can resolve it against its current character pose. |
| animation_drive | Option<(u64, AnimationDriveSettings, Option<f32>)> | Item, resolved drive, optional authoritative expiry time. Replicated with equipment. |
| rounds | std::collections::BTreeMap<u64, u32> | |
| reload | Option<ReloadProgress> | |
| reload_sequence | u32 | |
Source: crates/platinum-sdk/src/game/equipment.rs:7
platinum_sdk::game::EquipmentAnimationPose
pub struct EquipmentAnimationPose
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| item | u64 | |
| translation | [f32; 3] | |
| rotation | [f32; 4] | |
| scale | [f32; 3] | |
| settings | AnimationDriveSettings | |
Source: crates/platinum-sdk/src/game/equipment.rs:21
platinum_sdk::game::ReloadProgress
pub struct ReloadProgress
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| weapon | u64 | |
| finishes_at | f32 | |
Source: crates/platinum-sdk/src/game/equipment.rs:29
platinum_sdk::game::EquipmentCommand
pub enum EquipmentCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/equipment.rs:34
platinum_sdk::game::MatchObjective
pub enum MatchObjective
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/modes.rs:7
platinum_sdk::game::GameModeAsset
pub struct GameModeAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| description | String | |
| teams | bool | |
| player_damage | bool | |
| friendly_fire | bool | |
| show_targets | bool | |
| grant_loadout | bool | |
| objective | MatchObjective | |
| score_limit | u32 | Zero uses the project's combat limit, allowing map/project configuration. |
| duration_seconds | f32 | |
| script | Option<String> | |
| properties | BTreeMap<String, serde_json::Value> | |
| event_tables | Vec<String> | |
Source: crates/platinum-sdk/src/game/modes.rs:15
platinum_sdk::game::GameModeAsset::builtin
pub fn builtin(mode: MatchMode) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/modes.rs:53
platinum_sdk::game::GameModeAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/modes.rs:69
platinum_sdk::game::GameModeAsset::load
pub fn load(root: &Path, path: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/modes.rs:94
platinum_sdk::game::audio
platinum_sdk::game::audio
Device-independent sound policy and an optional Bevy audio output adapter.
Servers install `GameAudioPlugin::headless()`: no audio device is initialized.
Source: crates/platinum-sdk/src/game/audio/mod.rs:1
platinum_sdk::game::audio::AudioBus
pub enum AudioBus
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:18
platinum_sdk::game::audio::AttenuationCurve
pub enum AttenuationCurve
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:29
platinum_sdk::game::audio::SoundClip
pub struct SoundClip
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| duration | f32 | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:38
platinum_sdk::game::audio::SoundAsset
pub struct SoundAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| name | String | |
| clips | Vec<SoundClip> | |
| bus | AudioBus | |
| gain | f32 | |
| pitch | [f32; 2] | |
| looping | bool | |
| loop_timeout | Option<f32> | Optional renewable lease for sustained effects (e.g. a tool active while held). |
| spatial | bool | |
| min_distance | f32 | |
| max_distance | f32 | |
| attenuation | AttenuationCurve | |
| concurrency_group | String | Empty means this asset's path is its concurrency group. |
| max_voices | usize | |
| priority | u8 | Higher priority can steal lower priority voices. Equal priority steals oldest. |
Source: crates/platinum-sdk/src/game/audio/mod.rs:53
platinum_sdk::game::audio::SoundAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:95
platinum_sdk::game::audio::SoundAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:100
platinum_sdk::game::audio::SoundAsset::distance_gain
pub fn distance_gain(&self, distance: f32) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:136
platinum_sdk::game::audio::AudioMixer
pub struct AudioMixer
Persistent user settings; serialize in the host project's settings store.
Public data fields| Name | Type / declaration | Description |
|---|
| master | f32 | |
| music | f32 | |
| ambience | f32 | |
| effects | f32 | |
| ui | f32 | |
| muted | bool | |
| paused | bool | |
| pause_on_focus_loss | bool | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:157
platinum_sdk::game::audio::AudioMixer::gain
pub fn gain(&self, bus: AudioBus) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:182
platinum_sdk::game::audio::SoundCueId
pub struct SoundCueId
Exact identities survive serialization; never pass this through f32 expressions.
Public data fields| Name | Type / declaration | Description |
|---|
| epoch | u64 | |
| tick | u64 | |
| sequence | u32 | |
| source | u64 | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:202
platinum_sdk::game::audio::SoundCue
pub struct SoundCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | SoundCueId | |
| asset | String | |
| position | [f32; 3] | |
| emitter | Option<u64> | Follow a scene/network entity if it has a registered AudioEmitter component. |
| gain | f32 | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:209
platinum_sdk::game::audio::AudioEmitter
pub struct AudioEmitter
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| object | u64 | |
| enabled | bool | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:223
platinum_sdk::game::audio::GameAudioListener
pub struct GameAudioListener
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:228
platinum_sdk::game::audio::SoundLibrary
pub struct SoundLibrary
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| assets | BTreeMap<String, SoundAsset> | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:231
platinum_sdk::game::audio::SoundLibrary::insert
pub fn insert(&mut self, path: impl Into<String>, asset: SoundAsset) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:235
platinum_sdk::game::audio::SoundLibrary::load_manifest
pub fn load_manifest(&mut self, text: &str) -> Result<(), String>
Native/editor convenience. WASM receives the same JSON through project loading.
Source: crates/platinum-sdk/src/game/audio/mod.rs:241
platinum_sdk::game::audio::SoundLibrary::prefix_clip_paths
pub fn prefix_clip_paths(&mut self, prefix: &str)
Editor AssetServer root can contain several projects; exported games use an empty prefix.
Source: crates/platinum-sdk/src/game/audio/mod.rs:251
platinum_sdk::game::audio::AudioRequest
pub enum AudioRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:263
platinum_sdk::game::audio::AudioRequests
pub struct AudioRequests(pub VecDeque<AudioRequest>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:271
platinum_sdk::game::audio::AudioRequests::play
pub fn play(&mut self, cue: SoundCue)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:273
platinum_sdk::game::audio::AudioRequests::stop_emitter
pub fn stop_emitter(&mut self, id: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:276
platinum_sdk::game::audio::AudioVoice
pub struct AudioVoice
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | SoundCueId | |
| asset | String | |
| clip | String | |
| emitter | Option<u64> | |
| position | Vec3 | |
| pitch | f32 | |
| gain | f32 | |
| bus | AudioBus | |
| spatial | bool | |
| looping | bool | |
| loop_timeout | Option<f32> | |
| elapsed | f32 | |
| duration | f32 | |
| priority | u8 | |
| group | String | |
| distance_gain | f32 | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:282
platinum_sdk::game::audio::AudioState
pub struct AudioState
Inspectable logical voices work in tests and headless servers without an audio device.
Public data fields| Name | Type / declaration | Description |
|---|
| voices | Vec<AudioVoice> | |
| voice_limit | usize | |
| epoch | u64 | |
| rejected | u64 | |
| duplicates | u64 | |
| finished | Vec<SoundCueId> | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:302
platinum_sdk::game::audio::AudioState::request
pub fn request(&mut self, request: AudioRequest, library: &SoundLibrary)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:337
platinum_sdk::game::audio::AudioState::advance
pub fn advance(
&mut self,
dt: f32,
paused: bool,
listener: Vec3,
emitters: &BTreeMap<u64, Vec3>,
library: &SoundLibrary,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:443
platinum_sdk::game::audio::GameAudioPlugin
pub struct GameAudioPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| output | bool | |
Source: crates/platinum-sdk/src/game/audio/mod.rs:474
platinum_sdk::game::audio::GameAudioPlugin::headless
pub fn headless() -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:483
platinum_sdk::game::audio::AudioPolicySet
pub struct AudioPolicySet
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/mod.rs:527
platinum_sdk::game::audio::bridge
platinum_sdk::game::audio::bridge
Generic project cue routing; sample weapon/event choices live in project JSON.
Source: crates/platinum-sdk/src/game/audio/bridge.rs:1
platinum_sdk::game::audio::bridge::CueAudioBindings
pub struct CueAudioBindings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| events | BTreeMap<String, String> | |
| source_events | Vec<String> | For these events a source object's asset may choose a more specific sound. |
| sources | BTreeMap<String, String> | |
Source: crates/platinum-sdk/src/game/audio/bridge.rs:12
platinum_sdk::game::audio::bridge::CueAudioBridge
pub struct CueAudioBridge
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bindings | CueAudioBindings | |
Source: crates/platinum-sdk/src/game/audio/bridge.rs:19
platinum_sdk::game::audio::bridge::CueAudioBridge::emit_cues
pub fn emit_cues(
&mut self,
source: &impl crate::game::presentation_world::WorldPresentationSource,
requests: &mut AudioRequests,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/bridge.rs:26
platinum_sdk::game::audio::bridge::GameAudioBridgePlugin
pub struct GameAudioBridgePlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/bridge.rs:94
platinum_sdk::game::audio::inspector
platinum_sdk::game::audio::inspector
Reusable editor panel; the host owns transactions, save/apply/revert and preview routing.
Source: crates/platinum-sdk/src/game/audio/inspector.rs:1
platinum_sdk::game::audio::inspector::SoundInspectorResponse
pub struct SoundInspectorResponse
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| changed | bool | |
| preview | bool | |
| stop | bool | |
Source: crates/platinum-sdk/src/game/audio/inspector.rs:5
platinum_sdk::game::audio::inspector::sound_inspector
pub fn sound_inspector(ui: &mut egui::Ui, asset: &mut SoundAsset) -> SoundInspectorResponse
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/inspector.rs:10
platinum_sdk::game::audio::SoundEmitter
pub struct SoundEmitter
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset | String | |
| enabled | bool | |
| autoplay | bool | |
| gain | f32 | |
| offset | [f32; 3] | |
| overrides | Option<SoundAsset> | |
Source: crates/platinum-sdk/src/game/audio/scene.rs:7
platinum_sdk::game::audio::SoundEmitter::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/scene.rs:28
platinum_sdk::game::audio::SceneSounds
pub struct SceneSounds
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/scene.rs:47
platinum_sdk::game::audio::clear_sound_instances
pub fn clear_sound_instances(
commands: &mut Commands,
state: &mut SceneSounds,
requests: &mut AudioRequests,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/scene.rs:52
platinum_sdk::game::audio::SceneSoundPlugin
pub struct SceneSoundPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/scene.rs:63
platinum_sdk::game::audio::sync_sound_instances
pub fn sync_sound_instances(
commands: &mut Commands,
source: &impl crate::game::presentation_world::WorldPresentationSource,
root: &std::path::Path,
state: &mut SceneSounds,
library: &mut SoundLibrary,
requests: &mut AudioRequests,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/audio/scene.rs:89
platinum_sdk::game::character
platinum_sdk::game::character
Skeletal character assets, Bevy-backed clip blending, animation instances and IK.
Add `CharacterPlugin` after Bevy's asset/animation plugins. Spawn a transformed
`CharacterRig::new("path/profile.character.json")`; the plugin loads its skinned
glTF scene. Feed `CharacterMotion` or typed instance parameters from any controller.
Source: crates/platinum-sdk/src/game/character/mod.rs:1
platinum_sdk::game::character::CharacterSystems
pub enum CharacterSystems
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/mod.rs:25
platinum_sdk::game::character::CharacterPlugin
pub struct CharacterPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/mod.rs:29
platinum_sdk::game::character::BoneId
pub type BoneId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:6
platinum_sdk::game::character::bone_id
pub fn bone_id(path: &str) -> BoneId
Stable FNV-1a path ID; names are case sensitive and independent of ECS entity IDs.
Source: crates/platinum-sdk/src/game/character/asset.rs:8
platinum_sdk::game::character::CharacterParameter
pub enum CharacterParameter
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:15
platinum_sdk::game::character::ClipNotify
pub struct ClipNotify
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| time | f32 | |
| event | String | |
| payload | serde_json::Value | |
Source: crates/platinum-sdk/src/game/character/asset.rs:22
platinum_sdk::game::character::NotifyWindow
pub struct NotifyWindow
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| start | f32 | |
| end | f32 | |
| event | String | |
Source: crates/platinum-sdk/src/game/character/asset.rs:30
platinum_sdk::game::character::CharacterClip
pub struct CharacterClip
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| name | String | |
| gltf_index | usize | |
| duration | f32 | |
| looping | bool | |
| notifies | Vec<ClipNotify> | |
| windows | Vec<NotifyWindow> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:37
platinum_sdk::game::character::BlendSample
pub struct BlendSample
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| clip | u64 | |
| point | [f32; 2] | |
Source: crates/platinum-sdk/src/game/character/asset.rs:53
platinum_sdk::game::character::BlendSample1D
pub struct BlendSample1D
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| clip | u64 | |
| point | f32 | |
Source: crates/platinum-sdk/src/game/character/asset.rs:58
platinum_sdk::game::character::BlendSpace1D
pub struct BlendSpace1D
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| parameter | String | |
| samples | Vec<BlendSample1D> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:63
platinum_sdk::game::character::BlendSpace1D::weights
pub fn weights(&self, point: f32) -> Vec<(u64, f32)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:68
platinum_sdk::game::character::BlendSpace2D
pub struct BlendSpace2D
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| x | String | |
| y | String | |
| samples | Vec<BlendSample> | |
| triangles | Vec<[usize; 3]> | Explicit triangles avoid unstable triangulation at identical/collinear samples. |
Source: crates/platinum-sdk/src/game/character/asset.rs:95
platinum_sdk::game::character::BlendSpace2D::weights
pub fn weights(&self, point: Vec2) -> Vec<(u64, f32)>
Barycentric interpolation inside authored triangles; closest edge outside the hull.
Source: crates/platinum-sdk/src/game/character/asset.rs:104
platinum_sdk::game::character::PoseSource
pub enum PoseSource
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:170
platinum_sdk::game::character::CharacterSubgraph
pub struct CharacterSubgraph
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| initial_state | u64 | |
| states | Vec<CharacterState> | |
| transitions | Vec<StateTransition> | |
| positions | BTreeMap<u64, [f32; 2]> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:177
platinum_sdk::game::character::CharacterState
pub struct CharacterState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| name | String | |
| pose | PoseSource | |
Source: crates/platinum-sdk/src/game/character/asset.rs:187
platinum_sdk::game::character::ParameterCondition
pub enum ParameterCondition
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:194
platinum_sdk::game::character::ParameterCondition::matches
pub fn matches(&self, p: &BTreeMap<String, CharacterParameter>) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:201
platinum_sdk::game::character::StateTransition
pub struct StateTransition
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| from | u64 | |
| to | u64 | |
| duration | f32 | |
| conditions | Vec<ParameterCondition> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:219
platinum_sdk::game::character::BoneMask
pub struct BoneMask
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| bones | Vec<String> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:226
platinum_sdk::game::character::CharacterLayer
pub struct CharacterLayer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| clip | u64 | |
| weight_parameter | String | |
| mask | Option<String> | |
| additive | bool | |
| trigger | Option<String> | |
| fade_seconds | Option<f32> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:231
platinum_sdk::game::character::BoneSocket
pub struct BoneSocket
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| name | String | |
| bone | String | |
| translation | [f32; 3] | |
| rotation_degrees | [f32; 3] | |
Source: crates/platinum-sdk/src/game/character/asset.rs:244
platinum_sdk::game::character::CharacterFootIk
pub struct CharacterFootIk
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| upper | String | |
| lower | String | |
| foot | String | |
| pole | [f32; 3] | |
| probe_distance | f32 | |
| clearance | f32 | |
| max_adjustment | f32 | |
| weight | f32 | |
| plant_window | Option<String> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:251
platinum_sdk::game::character::CharacterHandIk
pub struct CharacterHandIk
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| upper | String | |
| lower | String | |
| hand | String | |
| target | [f32; 3] | |
| pole | [f32; 3] | |
| weight | f32 | |
| grip | Option<String> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:264
platinum_sdk::game::character::EquipmentGrip
pub struct EquipmentGrip
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| translation | [f32; 3] | |
| rotation_degrees | [f32; 3] | |
Source: crates/platinum-sdk/src/game/character/asset.rs:275
platinum_sdk::game::character::CharacterAsset
pub struct CharacterAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| facing | super::CharacterFacingSettings | |
| version | u32 | |
| name | String | |
| model | String | |
| initial_state | u64 | |
| graph_positions | BTreeMap<u64, [f32; 2]> | Editor layout only; runtime state transitions retain their existing semantics. |
| pose_graph | super::PoseGraph | |
| clips | Vec<CharacterClip> | |
| states | Vec<CharacterState> | |
| parameters | BTreeMap<String, CharacterParameter> | |
| transitions | Vec<StateTransition> | |
| masks | Vec<BoneMask> | |
| layers | Vec<CharacterLayer> | |
| sockets | Vec<BoneSocket> | |
| aim_spine | Vec<String> | |
| feet | Vec<CharacterFootIk> | |
| hands | Vec<CharacterHandIk> | |
| head_bone | Option<String> | |
| aim_origin | [f32; 3] | |
| first_person_offset | [f32; 3] | |
| skeleton_signature | Option<u64> | |
Source: crates/platinum-sdk/src/game/character/asset.rs:281
platinum_sdk::game::character::CharacterAsset::graph_signature
pub fn graph_signature(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:321
platinum_sdk::game::character::CharacterAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:325
platinum_sdk::game::character::CharacterAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/asset.rs:330
platinum_sdk::game::character::TwoBoneControl
pub struct TwoBoneControl
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| root | String | |
| middle | String | |
| end | String | |
| target | Vec3 | |
| pole | Vec3 | |
| weight | f32 | |
Source: crates/platinum-sdk/src/game/character/pose.rs:5
platinum_sdk::game::character::AimControl
pub struct AimControl
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bone | String | |
| target | Vec3 | |
| forward | Vec3 | |
| weight | f32 | |
| max_radians | f32 | |
Source: crates/platinum-sdk/src/game/character/pose.rs:16
platinum_sdk::game::character::SpineControl
pub struct SpineControl
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bones | Vec<String> | |
| pitch | f32 | |
| yaw | f32 | |
| weight | f32 | |
Source: crates/platinum-sdk/src/game/character/pose.rs:26
platinum_sdk::game::character::CharacterProceduralControls
pub struct CharacterProceduralControls
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| spine | Option<SpineControl> | |
| manual_spine | bool | An explicit spine command takes precedence over motion-driven aiming until cleared. |
| look | Vec<AimControl> | |
| limbs | Vec<TwoBoneControl> | |
| enabled | bool | Resetting controls is sufficient to release hand grips/foot plants on gear changes. |
Source: crates/platinum-sdk/src/game/character/pose.rs:33
platinum_sdk::game::character::CharacterBones
pub struct CharacterBones(pub BTreeMap<BoneId, Entity>)
Stable IDs for sockets and bones, populated from the imported scene.
Source: crates/platinum-sdk/src/game/character/pose.rs:44
platinum_sdk::game::character::CharacterAttachment
pub struct CharacterAttachment
A socket target follows a character bone after the final pose. Do not target an IK
chain back at an attachment following that same chain: validate dependencies first.
Public data fields| Name | Type / declaration | Description |
|---|
| character | Entity | |
| bone | String | |
| offset | Transform | |
Source: crates/platinum-sdk/src/game/character/pose.rs:133
platinum_sdk::game::character::CharacterSocketAttachment
pub struct CharacterSocketAttachment
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| character | Entity | |
| socket | String | |
Source: crates/platinum-sdk/src/game/character/pose.rs:139
platinum_sdk::game::character::CharacterGearAttachment
pub struct CharacterGearAttachment
Mesh-local grip markers for equipment attached to an existing character socket.
The anchor grip follows the socket; other named hand grips are solved afterwards.
Public data fields| Name | Type / declaration | Description |
|---|
| anchor_grip | String | |
| grips | BTreeMap<String, EquipmentGrip> | |
| scale | Vec3 | |
| playback | crate::game::AnimationDriveSettings | |
| animation_offset | Transform | Local object-animation delta, independent of the skeletal grip pose. |
| body | Option<crate::game::RigidBody> | |
Source: crates/platinum-sdk/src/game/character/pose.rs:146
platinum_sdk::game::character::CharacterGearMotionSample
pub struct CharacterGearMotionSample
Current-frame diagnostic/FX matrices. `authored` never includes ragdoll output;
`resolved` includes optional item-body dynamics and is the hand/mesh target.
Public data fields| Name | Type / declaration | Description |
|---|
| authored | Transform | |
| resolved | Transform | |
Source: crates/platinum-sdk/src/game/character/pose.rs:158
platinum_sdk::game::character::CharacterViewModel
pub struct CharacterViewModel
Exact presentation matrices shared with the existing first-person gun renderer.
Public data fields| Name | Type / declaration | Description |
|---|
| camera | Transform | |
| weapon | Transform | |
| grips | BTreeMap<String, EquipmentGrip> | |
Source: crates/platinum-sdk/src/game/character/pose.rs:169
platinum_sdk::game::character::CharacterGroundGeometry
pub struct CharacterGroundGeometry
Presentation collision input. Scene adapters supply visible walkable colliders;
custom physics backends can replace this resource's height-query inputs.
Public data fields| Name | Type / declaration | Description |
|---|
| objects | Vec<crate::game::SceneObject> | |
| preview_plane | Option<f32> | |
Source: crates/platinum-sdk/src/game/character/pose.rs:177
platinum_sdk::game::character::CharacterGroundOverride
pub struct CharacterGroundOverride(CharacterGroundGeometry)
Optional presentation-only collision inputs for an isolated character view.
Gameplay rigs without this component retain the shared scene sampler.
Source: crates/platinum-sdk/src/game/character/pose.rs:184
platinum_sdk::game::character::CharacterGroundOverride::new
pub fn new(geometry:CharacterGroundGeometry)->Result<Self,String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/pose.rs:186
platinum_sdk::game::character::CharacterGroundOverride::plane
pub fn plane(height:f32)->Result<Self,String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/pose.rs:191
platinum_sdk::game::character::CharacterGroundOverride::geometry
pub fn geometry(&self)->&CharacterGroundGeometry
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/pose.rs:192
platinum_sdk::game::character::CharacterGroundGeometry::set_scene
pub fn set_scene(
&mut self,
scene: &crate::game::SceneDocument,
hidden: &std::collections::HashSet<u64>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/pose.rs:195
platinum_sdk::game::character::CharacterGroundGeometry::height
pub fn height(&self, x: f32, z: f32) -> Option<f32>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/pose.rs:212
platinum_sdk::game::character::validate_pose_dependencies
pub fn validate_pose_dependencies(edges: &[(String, String)]) -> Result<(), String>
Validate named procedural dependencies before installing controls.
Source: crates/platinum-sdk/src/game/character/pose.rs:217
platinum_sdk::game::character::solve_two_bone
pub fn solve_two_bone(
root: Vec3,
middle: Vec3,
end: Vec3,
target: Vec3,
pole: Vec3,
) -> Option<(Vec3, Vec3)>
Analytic two-bone elbow/knee solve with reach clamp and a stable pole fallback.
Source: crates/platinum-sdk/src/game/character/pose.rs:250
platinum_sdk::game::character::ground_foot_target
pub fn ground_foot_target(
foot: Vec3,
up: Vec3,
distance: f32,
clearance: f32,
mut raycast: impl FnMut(Vec3, Vec3, f32) -> Option<Vec3>,
) -> Option<Vec3>
Foot probes are provided by physics (authority or presentation). This helper avoids
binding the character engine to a sample collision world or a particular backend.
Source: crates/platinum-sdk/src/game/character/pose.rs:284
platinum_sdk::game::character::PoseGraph
pub struct PoseGraph
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| nodes | Vec<PoseNode> | |
| output | Option<u64> | |
| positions | BTreeMap<u64, [f32; 2]> | |
Source: crates/platinum-sdk/src/game/character/graph.rs:6
platinum_sdk::game::character::PoseNode
pub struct PoseNode
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| name | String | |
| input | Option<u64> | |
| op | PoseOp | |
Source: crates/platinum-sdk/src/game/character/graph.rs:15
platinum_sdk::game::character::PoseOp
pub enum PoseOp
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/graph.rs:23
platinum_sdk::game::character::PhysicalBone
pub struct PhysicalBone
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bone | String | |
| parent | Option<usize> | |
| half_extents | [f32; 3] | |
| mass | f32 | |
Source: crates/platinum-sdk/src/game/character/graph.rs:49
platinum_sdk::game::character::PhysicalAnimationSettings
pub struct PhysicalAnimationSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bones | Vec<PhysicalBone> | |
| weight | f32 | |
| weight_parameter | String | |
| frequency | f32 | |
| damping | f32 | |
| hit_recovery | f32 | |
Source: crates/platinum-sdk/src/game/character/graph.rs:57
platinum_sdk::game::character::PhysicalAnimationSettings::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/graph.rs:78
platinum_sdk::game::character::PoseGraph::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/graph.rs:119
platinum_sdk::game::character::CharacterImpact
pub struct CharacterImpact
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| sequence | String | |
| position | Vec3 | |
| impulse | Vec3 | |
| dead | bool | |
Source: crates/platinum-sdk/src/game/character/physical.rs:6
platinum_sdk::game::character::CharacterCue
pub struct CharacterCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| sequence | u32 | |
| character | Entity | |
| clip | u64 | |
| id | u64 | |
| event | String | |
| phase | NotifyPhase | |
| payload | serde_json::Value | |
Source: crates/platinum-sdk/src/game/character/runtime.rs:5
platinum_sdk::game::character::NotifyPhase
pub enum NotifyPhase
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:15
platinum_sdk::game::character::CharacterCues
pub struct CharacterCues(pub Vec<CharacterCue>)
Consumers drain cues once per frame. These presentation cues must not award damage or ammunition.
Source: crates/platinum-sdk/src/game/character/runtime.rs:23
platinum_sdk::game::character::CharacterRig
pub struct CharacterRig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset | String | |
| asset_root | String | |
Source: crates/platinum-sdk/src/game/character/runtime.rs:25
platinum_sdk::game::character::CharacterAssetHandle
pub struct CharacterAssetHandle(pub Handle<CharacterAsset>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:31
platinum_sdk::game::character::CharacterRig::new
pub fn new(asset: impl Into<String>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:33
platinum_sdk::game::character::CharacterRig::with_asset_root
pub fn with_asset_root(mut self, root: impl Into<String>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:41
platinum_sdk::game::character::CharacterRig::resolved
pub fn resolved(&self, path: &str) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:45
platinum_sdk::game::character::CharacterMotion
pub struct CharacterMotion
Parameters supplied by a controller, network presentation, Lua, or Events.
Public data fields| Name | Type / declaration | Description |
|---|
| view_yaw | f32 | |
| turn_rate | f32 | |
| gait_phase | f32 | |
| local_velocity | Vec3 | |
| grounded | bool | |
| crouched | bool | |
| sprinting | bool | |
| locomotion | super::super::SprintState | |
| aim_pitch | f32 | |
| aim_yaw | f32 | |
| action | Option<String> | |
| equipment_weight | f32 | |
Source: crates/platinum-sdk/src/game/character/runtime.rs:55
platinum_sdk::game::character::CharacterAnimationInstance
pub struct CharacterAnimationInstance
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| parameters | BTreeMap<String, CharacterParameter> | |
| state | u64 | |
| weights | BTreeMap<u64, f32> | |
| phase | f32 | |
| paused | bool | |
| override_clip | Option<u64> | |
| state_elapsed | f32 | |
| layer_weights | std::collections::BTreeMap<usize, f32> | |
| layer_times | std::collections::BTreeMap<usize, f32> | |
Source: crates/platinum-sdk/src/game/character/runtime.rs:70
platinum_sdk::game::character::CharacterAnimationInstance::carry_weight
pub fn carry_weight(&self) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:89
platinum_sdk::game::character::CharacterAnimationInstance::sample_time
pub fn sample_time(&self, clip: &CharacterClip) -> f32
The same sampling clock is used by Bevy presentation and authority skinning.
Source: crates/platinum-sdk/src/game/character/runtime.rs:96
platinum_sdk::game::character::CharacterAnimationInstance::active_window_events
pub fn active_window_events(
&self,
asset: &CharacterAsset,
) -> std::collections::BTreeSet<String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:107
platinum_sdk::game::character::CharacterAnimationInstance::new
pub fn new(asset: &CharacterAsset) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:123
platinum_sdk::game::character::CharacterAnimationInstance::set_float
pub fn set_float(&mut self, name: impl Into<String>, value: f32)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:143
platinum_sdk::game::character::CharacterAnimationInstance::set_bool
pub fn set_bool(&mut self, name: impl Into<String>, value: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:149
platinum_sdk::game::character::CharacterAnimationInstance::trigger
pub fn trigger(&mut self, name: impl Into<String>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:153
platinum_sdk::game::character::CharacterAnimationInstance::float
pub fn float(&self, name: &str) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:157
platinum_sdk::game::character::CharacterAnimationInstance::seek
pub fn seek(&mut self, phase: f32)
Silent editor seek; closes active windows on the next runtime update.
Source: crates/platinum-sdk/src/game/character/runtime.rs:164
platinum_sdk::game::character::CharacterAnimationInstance::advance
pub fn advance(
&mut self,
asset: &CharacterAsset,
delta: f32,
entity: Entity,
cues: &mut Vec<CharacterCue>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:169
platinum_sdk::game::character::CharacterAnimationInstance::stop
pub fn stop(&mut self, asset: &CharacterAsset, entity: Entity, cues: &mut Vec<CharacterCue>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/runtime.rs:382
platinum_sdk::game::character::CharacterFacingSettings
pub struct CharacterFacingSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| idle_turn_degrees | f32 | |
| maximum_turn_degrees_per_second | f32 | |
| walk_stride | f32 | |
| sprint_stride | f32 | |
| crouch_stride | f32 | |
| turn_stride_degrees | f32 | |
Source: crates/platinum-sdk/src/game/character/facing.rs:7
platinum_sdk::game::character::CharacterFacingSettings::validate
pub fn validate(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/facing.rs:28
platinum_sdk::game::character::shortest_yaw
pub fn shortest_yaw(angle: f32) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/facing.rs:41
platinum_sdk::game::character::CharacterFacing
pub struct CharacterFacing
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| yaw | f32 | |
| turn_rate | f32 | |
| gait_phase | f32 | |
| moving_weight | f32 | |
| acceleration | Vec3 | |
Source: crates/platinum-sdk/src/game/character/facing.rs:46
platinum_sdk::game::character::CharacterFacing::step
pub fn step(
&mut self,
view_yaw: f32,
velocity: Vec3,
grounded: bool,
crouched: bool,
sprinting: bool,
dt: f32,
settings: &CharacterFacingSettings,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/facing.rs:57
platinum_sdk::game::character::CharacterHitMesh
pub struct CharacterHitMesh
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:23
platinum_sdk::game::character::CharacterMeshHit
pub struct CharacterMeshHit
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| distance | f32 | |
| normal | Vec3 | |
| head | bool | |
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:34
platinum_sdk::game::character::CharacterHitMesh::set_head_bone
pub fn set_head_bone(&mut self, name: &str)
Classify head triangles from the authored profile, including descendants.
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:63
platinum_sdk::game::character::CharacterHitMesh::from_gltf
pub fn from_gltf(
text: &str,
mut external: impl FnMut(&str) -> Result<Vec<u8>, String>,
) -> Result<Self, String>
Accept embedded or caller-resolved buffers. Accessors support interleaved
float/normalized weights, 8/16-bit joints and 8/16/32-bit indices.
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:97
platinum_sdk::game::character::CharacterHitMesh::skin
pub fn skin(
&self,
profile: &CharacterAsset,
instance: &CharacterAnimationInstance,
pitch: f32,
yaw: f32,
) -> Vec<Vec3>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:577
platinum_sdk::game::character::CharacterHitMesh::raycast
pub fn raycast(
&self,
vertices: &[Vec3],
origin: Vec3,
direction: Vec3,
max_distance: f32,
) -> Option<CharacterMeshHit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/hit_mesh.rs:602
platinum_sdk::game::character::CharacterSceneBinding
pub struct CharacterSceneBinding
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| object_id | u64 | |
Source: crates/platinum-sdk/src/game/character/bridge.rs:6
platinum_sdk::game::character::CharacterPlayerBinding
pub struct CharacterPlayerBinding
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| player | PlayerId | |
Source: crates/platinum-sdk/src/game/character/bridge.rs:10
platinum_sdk::game::character::CharacterCommand
pub enum CharacterCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/bridge.rs:15
platinum_sdk::game::character::CharacterCommands
pub struct CharacterCommands(pub Vec<CharacterCommand>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/bridge.rs:42
platinum_sdk::game::character::CharacterPresentationConfig
pub struct CharacterPresentationConfig
Project-relative character profile and presentation choices supplied by a project.
Public data fields| Name | Type / declaration | Description |
|---|
| presentation_generation | u64 | Changes whenever a new authority session is accepted, even if epochs repeat. |
| player_profile | Option<String> | |
| first_person_profile | Option<String> | |
| asset_root | String | |
| local_player | Option<PlayerId> | |
| hide_local | bool | |
Source: crates/platinum-sdk/src/game/character/bridge.rs:45
platinum_sdk::game::character::CharacterPlayerPresentation
pub struct CharacterPlayerPresentation
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| roots | BTreeMap<u64, Entity> | |
Source: crates/platinum-sdk/src/game/character/bridge.rs:55
platinum_sdk::game::character::attach_character
pub fn attach_character(
commands: &mut Commands,
entity: Entity,
object: &SceneObject,
asset_root: &str,
)
Call alongside a scene renderer's normal component attachment. Kept separate so
editor asset roots and exported project roots use the same persisted component.
Source: crates/platinum-sdk/src/game/character/bridge.rs:118
platinum_sdk::game::character::sync_character_players
pub fn sync_character_players(
commands: &mut Commands,
server: &AssetServer,
source: &impl crate::game::presentation_world::WorldPresentationSource,
config: &CharacterPresentationConfig,
state: &mut CharacterPlayerPresentation,
)
Reusable renderer for all player bodies, including remotely replicated players.
Call once per presentation frame; local first-person body hiding is configurable.
Source: crates/platinum-sdk/src/game/character/bridge.rs:139
platinum_sdk::game::character::CharacterSceneBridgePlugin
pub struct CharacterSceneBridgePlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/bridge.rs:413
platinum_sdk::game::character::CharacterPreviewRoot
pub struct CharacterPreviewRoot
Character-only scene root for the editor's existing isolated model viewport.
Source: crates/platinum-sdk/src/game/character/bridge.rs:578
platinum_sdk::game::character::spawn_character_preview
pub fn spawn_character_preview(
commands: &mut Commands,
profile: &str,
asset_root: &str,
layer: usize,
) -> Entity
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/bridge.rs:579
platinum_sdk::game::character::IsolatedCharacterPreview
pub struct IsolatedCharacterPreview
Marks a renderer/editor audition root, distinct from the primary editor
character. Its profile and physics presentation are local view resources.
Source: crates/platinum-sdk/src/game/character/bridge.rs:600
platinum_sdk::game::character::CharacterPreviewSuspended
pub struct CharacterPreviewSuspended
Host visibility suspension; no graph, IK or isolated physical stepping.
Source: crates/platinum-sdk/src/game/character/bridge.rs:603
platinum_sdk::game::character::CharacterPreviewCues
pub struct CharacterPreviewCues
Bounded local notify diagnostics. These cues never enter CharacterCues,
gameplay audio, events, or replicated presentation streams.
Public data fields| Name | Type / declaration | Description |
|---|
| records | Vec<CharacterCue>,pub dropped:u64 | |
Source: crates/platinum-sdk/src/game/character/bridge.rs:607
platinum_sdk::game::character::spawn_isolated_character_preview
pub fn spawn_isolated_character_preview(commands:&mut Commands,profile:Handle<CharacterAsset>,label:&str,asset_root:&str,layer:usize)->Result<Entity,String>
Spawn a view using a uniquely owned, prepared profile handle. This bypasses
the path loader without modifying a shared gameplay AssetServer profile.
Source: crates/platinum-sdk/src/game/character/bridge.rs:610
platinum_sdk::game::character::character_command_from_script
pub fn character_command_from_script(
name: &str,
args: &[serde_json::Value],
) -> Option<CharacterCommand>
Shared browser bridge decoder. Native bindings use the same parameter and target contracts.
Source: crates/platinum-sdk/src/game/character/bridge.rs:621
platinum_sdk::game::character::ReplicatedCharacterState
pub struct ReplicatedCharacterState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| parameters | BTreeMap<String, CharacterParameter> | |
| limbs | BTreeMap<String, TwoBoneControl> | |
| look | BTreeMap<String, AimControl> | |
| spine | Option<SpineControl> | |
Source: crates/platinum-sdk/src/game/character/replication.rs:12
platinum_sdk::game::character::CharacterTriggerCue
pub struct CharacterTriggerCue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | CueId | |
| object | u64 | |
| trigger | String | |
Source: crates/platinum-sdk/src/game/character/replication.rs:19
platinum_sdk::game::character::CharacterReplicationState
pub struct CharacterReplicationState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| epoch | u64 | |
| objects | BTreeMap<u64, ReplicatedCharacterState> | |
| triggers | VecDeque<CharacterTriggerCue> | |
Source: crates/platinum-sdk/src/game/character/replication.rs:25
platinum_sdk::game::character::CharacterReplicationCursor
pub struct CharacterReplicationCursor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/replication.rs:33
platinum_sdk::game::character::CharacterReplicationState::reset_epoch
pub fn reset_epoch(&mut self, epoch: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/replication.rs:74
platinum_sdk::game::character::CharacterReplicationState::validate
pub fn validate(&self, epoch: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/replication.rs:80
platinum_sdk::game::character::CharacterReplicationState::record
pub fn record(&mut self, command: &CharacterCommand, tick: SimulationTick, epoch: u64) -> bool
Record validated authority-origin commands. Returns false if its bounded
storage refuses an invalid or excessive entry; callers should also skip it locally.
Source: crates/platinum-sdk/src/game/character/replication.rs:118
platinum_sdk::game::character::CharacterReplicationState::prune_objects
pub fn prune_objects(&mut self, keep: impl Fn(u64) -> bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/replication.rs:194
platinum_sdk::game::character::CharacterReplicationState::enqueue_snapshot
pub fn enqueue_snapshot(
&self,
cursor: &mut CharacterReplicationCursor,
queue: &mut Vec<CharacterCommand>,
)
Baselines install persistent values and mark historical triggers consumed.
Later repeated snapshots deliver each exact CueId only once.
Source: crates/platinum-sdk/src/game/character/replication.rs:200
platinum_sdk::game::character::SkeletonBone
pub struct SkeletonBone
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | BoneId | |
| name | String | |
| path | String | |
| parent | Option<BoneId> | |
Source: crates/platinum-sdk/src/game/character/skeleton.rs:6
platinum_sdk::game::character::CharacterSkeleton
pub struct CharacterSkeleton
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| signature | u64 | |
| bones | Vec<SkeletonBone> | |
Source: crates/platinum-sdk/src/game/character/skeleton.rs:13
platinum_sdk::game::character::CharacterImportError
pub struct CharacterImportError(pub String)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/skeleton.rs:18
platinum_sdk::game::character::CharacterSkeleton::from_paths
pub fn from_paths(records: Vec<(String, String)>) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/skeleton.rs:20
platinum_sdk::game::character::CharacterLodPolicy
pub struct CharacterLodPolicy
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| near_distance | f32 | |
| far_distance | f32 | |
| far_hz | f32 | |
| distant_hz | f32 | |
| observer | Option<Vec3> | |
Source: crates/platinum-sdk/src/game/character/lod.rs:5
platinum_sdk::game::character::CharacterLodPolicy::interval
pub fn interval(&self, distance: f32, first_person: bool) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/character/lod.rs:24
platinum_sdk::game::character::CharacterLod
pub struct CharacterLod
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| interval | f32 | |
| evaluate | bool | |
Source: crates/platinum-sdk/src/game/character/lod.rs:35
platinum_sdk::game::LuaCommand
pub enum LuaCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lua_command.rs:2
platinum_sdk::game::network
platinum_sdk::game::network
Versioned client input / authority snapshot protocol. Transport never grants gameplay authority.
WebSocket, optional encrypted QUIC/WebTransport and pinned-authority WebRTC rooms
share one ownership, readiness and authoritative simulation protocol.
Source: crates/platinum-sdk/src/game/network/mod.rs:1
platinum_sdk::game::network::MAX_PACKET_BYTES
pub const MAX_PACKET_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:32
platinum_sdk::game::network::MAX_CLIENT_PACKET_BYTES
pub const MAX_CLIENT_PACKET_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:33
platinum_sdk::game::network::ClientPacket
pub enum ClientPacket
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:37
platinum_sdk::game::network::ServerPacket
pub enum ServerPacket
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:72
platinum_sdk::game::network::encode_client
pub fn encode_client(packet: &ClientPacket) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:105
platinum_sdk::game::network::decode_client
pub fn decode_client(text: &str) -> Result<ClientPacket, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:112
platinum_sdk::game::network::encode_server
pub fn encode_server(packet: &ServerPacket) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:118
platinum_sdk::game::network::decode_server
pub fn decode_server(text: &str) -> Result<ServerPacket, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:125
platinum_sdk::game::network::ServerConfig
pub struct ServerConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| max_players | usize | |
| join_secret | String | Empty allows LAN guests. Public deployments require TLS/reverse proxy and authentication. |
| project_hash | String | |
| host_name | String | |
| snapshots_per_second | u32 | |
| input_timeout_seconds | f64 | |
| disconnect_timeout_seconds | f64 | |
| level_timeout_seconds | f64 | |
Source: crates/platinum-sdk/src/game/network/mod.rs:134
platinum_sdk::game::network::ServerConfig::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:160
platinum_sdk::game::network::AuthorityProtocol
pub struct AuthorityProtocol
Pure authority adapter; can be reused by a WebRTC transport without changing game logic.
Public data fields| Name | Type / declaration | Description |
|---|
| config | ServerConfig | |
Source: crates/platinum-sdk/src/game/network/mod.rs:202
platinum_sdk::game::network::AuthorityProtocol::new
pub fn new(config: ServerConfig) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:217
platinum_sdk::game::network::AuthorityProtocol::connected_players
pub fn connected_players(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:228
platinum_sdk::game::network::AuthorityProtocol::receive
pub fn receive(
&mut self,
connection: u64,
packet: ClientPacket,
session: &mut FpsSession,
now: f64,
) -> Option<ServerPacket>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:231
platinum_sdk::game::network::AuthorityProtocol::disconnect
pub fn disconnect(&mut self, connection: u64, session: &mut FpsSession)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:413
platinum_sdk::game::network::AuthorityProtocol::inputs
pub fn inputs(&mut self, now: f64) -> BTreeMap<PlayerId, GameInput>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:422
platinum_sdk::game::network::AuthorityProtocol::expired
pub fn expired(&self, now: f64) -> Vec<u64>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:436
platinum_sdk::game::network::AuthorityProtocol::step_session
pub fn step_session(
&mut self,
session: &mut FpsSession,
dt: f32,
inputs: &BTreeMap<PlayerId, GameInput>,
)
A receipt is not an acknowledgment of simulation. Sub-tick updates can
retain accumulated look/action edges without including them in a pose.
Both transport authorities use this boundary before publishing snapshots.
Source: crates/platinum-sdk/src/game/network/mod.rs:446
platinum_sdk::game::network::AuthorityProtocol::snapshots
pub fn snapshots(&self, session: &FpsSession) -> Vec<(u64, ServerPacket)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:460
platinum_sdk::game::network::AuthorityProtocol::observe_level
pub fn observe_level(&mut self, session: &mut FpsSession, now: f64)
Freeze a newly switched authority epoch until every connected client has preloaded it.
Source: crates/platinum-sdk/src/game/network/mod.rs:480
platinum_sdk::game::network::AuthorityProtocol::take_control
pub fn take_control(&mut self) -> Vec<(u64, ServerPacket)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/mod.rs:538
platinum_sdk::game::network::ConnectionState
pub struct ConnectionState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| connected | bool | |
| player | Option<PlayerId> | |
| epoch | u64 | |
| tick | u64 | |
| last_ack | u64 | |
| error | Option<String> | |
| expected_project | String | |
| lobby | LobbyState | |
Source: crates/platinum-sdk/src/game/network/mod.rs:544
platinum_sdk::game::network::bridge
platinum_sdk::game::network::bridge
Session/menu adapter. The caller's input system calls `tick` instead of local simulation.
Source: crates/platinum-sdk/src/game/network/bridge.rs:1
platinum_sdk::game::network::bridge::NetworkRuntime
pub struct NetworkRuntime
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| presentation_generation | u64 | Local presentation identity; independent of an authority's reusable epoch numbers. |
| connection | Option<Connection> | |
| webtransport | Option<webtransport::Connection> | |
| host | Option<NetworkServer> | |
| status | String | |
| prediction | prediction::ClientPrediction | |
| p2p | Option<p2p::P2pSession> | |
Source: crates/platinum-sdk/src/game/network/bridge.rs:10
platinum_sdk::game::network::bridge::NetworkRuntime::ready_for_play
pub fn ready_for_play(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:48
platinum_sdk::game::network::bridge::NetworkRuntime::lobby_state
pub fn lobby_state(&self, session: &FpsSession) -> Option<LobbyState>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:69
platinum_sdk::game::network::bridge::NetworkRuntime::ui_action
pub fn ui_action(
&mut self,
session: &mut FpsSession,
action: &str,
value: &str,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:87
platinum_sdk::game::network::bridge::NetworkRuntime::ready_round
pub fn ready_round(&mut self, session: &mut FpsSession) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:117
platinum_sdk::game::network::bridge::NetworkRuntime::is_remote
pub fn is_remote(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:145
platinum_sdk::game::network::bridge::NetworkRuntime::is_networked
pub fn is_networked(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:159
platinum_sdk::game::network::bridge::NetworkRuntime::disconnect
pub fn disconnect(&mut self, session: &mut FpsSession) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:180
platinum_sdk::game::network::bridge::NetworkRuntime::tick
pub fn tick(
&mut self,
session: &mut FpsSession,
dt: f32,
input: GameInput,
) -> Result<bool, String>
True means this adapter consumed input and owns world advancement.
Source: crates/platinum-sdk/src/game/network/bridge.rs:216
platinum_sdk::game::network::bridge::NetworkMenuSet
pub struct NetworkMenuSet
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:373
platinum_sdk::game::network::bridge::GameNetworkPlugin
pub struct GameNetworkPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/bridge.rs:374
platinum_sdk::game::network::LobbyPlayer
pub struct LobbyPlayer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | PlayerId | |
| name | String | |
| ready | bool | |
| assets_ready | bool | |
| authority | bool | |
Source: crates/platinum-sdk/src/game/network/lobby.rs:4
platinum_sdk::game::network::LobbyState
pub struct LobbyState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| players | Vec<LobbyPlayer> | |
| can_start | bool | |
Source: crates/platinum-sdk/src/game/network/lobby.rs:12
platinum_sdk::game::network::manifest
platinum_sdk::game::network::manifest
Deterministic project compatibility. This is a content hash, not a signature or authentication.
Source: crates/platinum-sdk/src/game/network/manifest.rs:1
platinum_sdk::game::network::manifest::MANIFEST_PATH
pub const MANIFEST_PATH: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:5
platinum_sdk::game::network::manifest::AssetDigest
pub struct AssetDigest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| sha256 | String | |
| bytes | u64 | |
Source: crates/platinum-sdk/src/game/network/manifest.rs:7
platinum_sdk::game::network::manifest::CompatibilityManifest
pub struct CompatibilityManifest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| digest | String | |
| files | BTreeMap<String, AssetDigest> | |
Source: crates/platinum-sdk/src/game/network/manifest.rs:12
platinum_sdk::game::network::manifest::runtime_asset
pub fn runtime_asset(path: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:20
platinum_sdk::game::network::manifest::CompatibilityManifest::from_files
pub fn from_files(files: &BTreeMap<String, Vec<u8>>) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:44
platinum_sdk::game::network::manifest::CompatibilityManifest::from_inventory
pub fn from_inventory(files:BTreeMap<String,AssetDigest>)->Result<Self,String>
Exact whole-file SHA metadata from an admitted immutable source. Chunk
digests alone are not a substitute for a file's SHA256. No payload scan.
Source: crates/platinum-sdk/src/game/network/manifest.rs:62
platinum_sdk::game::network::manifest::CompatibilityManifest::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:85
platinum_sdk::game::network::manifest::CompatibilityManifest::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:106
platinum_sdk::game::network::manifest::CompatibilityManifest::verify_file
pub fn verify_file(&self, path: &str, bytes: &[u8]) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:114
platinum_sdk::game::network::manifest::CompatibilityManifest::load
pub fn load(root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:124
platinum_sdk::game::network::manifest::read_runtime_files
pub fn read_runtime_files(root: &Path) -> Result<BTreeMap<String, Vec<u8>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/manifest.rs:151
platinum_sdk::game::network::validate_ui_action
pub fn validate_ui_action(action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/ui_actions.rs:3
platinum_sdk::game::network::p2p
platinum_sdk::game::network::p2p
Matchbox WebRTC adapter using the same input/authority protocol as dedicated play.
A join endpoint pins the authority PeerId; unrelated mesh peers cannot send authority snapshots.
Source: crates/platinum-sdk/src/game/network/p2p.rs:1
platinum_sdk::game::network::p2p::IceServer
pub struct IceServer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| urls | Vec<String> | |
| username | Option<String> | |
| credential | Option<String> | |
Source: crates/platinum-sdk/src/game/network/p2p.rs:11
platinum_sdk::game::network::p2p::P2pConfig
pub struct P2pConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| signaling | String | ws(s) URL including the room path, without the p2p+ prefix or peer-id fragment. |
| name | String | |
| secret | String | |
| ice | Vec<IceServer> | |
| server | ServerConfig | |
Source: crates/platinum-sdk/src/game/network/p2p.rs:17
platinum_sdk::game::network::p2p::P2pSession
pub struct P2pSession
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ConnectionState | |
| status | String | |
Source: crates/platinum-sdk/src/game/network/p2p.rs:198
platinum_sdk::game::network::p2p::P2pSession::host
pub fn host(config: P2pConfig) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:220
platinum_sdk::game::network::p2p::P2pSession::join
pub fn join(endpoint: &str, mut config: P2pConfig) -> Result<Self, String>
Endpoint format: p2p+ws(s)://signaling/room#authority-peer-uuid.
Source: crates/platinum-sdk/src/game/network/p2p.rs:224
platinum_sdk::game::network::p2p::P2pSession::is_host
pub fn is_host(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:268
platinum_sdk::game::network::p2p::P2pSession::presentation_generation
pub fn presentation_generation(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:271
platinum_sdk::game::network::p2p::P2pSession::take_preparing
pub fn take_preparing(&mut self) -> Option<(u64, String, String)>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:274
platinum_sdk::game::network::p2p::P2pSession::is_loading
pub fn is_loading(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:277
platinum_sdk::game::network::p2p::P2pSession::ready
pub fn ready(&mut self, epoch: u64, project_hash: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:280
platinum_sdk::game::network::p2p::P2pSession::lobby
pub fn lobby(&self, session: &FpsSession) -> LobbyState
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:290
platinum_sdk::game::network::p2p::P2pSession::start_round
pub fn start_round(&mut self, session: &mut FpsSession) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:295
platinum_sdk::game::network::p2p::P2pSession::lobby_ready
pub fn lobby_ready(&mut self, ready: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:301
platinum_sdk::game::network::p2p::P2pSession::ui_action
pub fn ui_action(&mut self, action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:307
platinum_sdk::game::network::p2p::P2pSession::endpoint
pub fn endpoint(&mut self) -> Option<String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:324
platinum_sdk::game::network::p2p::P2pSession::tick
pub fn tick(
&mut self,
session: &mut FpsSession,
dt: f32,
input: GameInput,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:335
platinum_sdk::game::network::p2p::P2pSession::disconnect
pub fn disconnect(&mut self, session: &mut FpsSession)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/p2p.rs:537
platinum_sdk::game::network::prediction
platinum_sdk::game::network::prediction
Bounded client movement prediction and remote interpolation. This advances only
the shared kinematic controller; Lua, Jolt, damage and equipment stay authoritative.
Source: crates/platinum-sdk/src/game/network/prediction.rs:1
platinum_sdk::game::network::prediction::PredictedPawn
pub struct PredictedPawn
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| position | Vec3 | |
| velocity | Vec3 | |
| grounded | bool | |
| crouched | bool | |
| sprinting | bool | |
| locomotion | crate::game::SprintState | |
| facing | crate::game::character::CharacterFacing | |
| yaw | f32 | |
| pitch | f32 | |
Source: crates/platinum-sdk/src/game/network/prediction.rs:10
platinum_sdk::game::network::prediction::PredictionDiagnostics
pub struct PredictionDiagnostics
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reconciliations | u64 | |
| last_error | f32 | |
| largest_error | f32 | |
| dropped_inputs | u64 | |
| pending_inputs | usize | |
Source: crates/platinum-sdk/src/game/network/prediction.rs:103
platinum_sdk::game::network::prediction::ClientPrediction
pub struct ClientPrediction
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| diagnostics | PredictionDiagnostics | |
Source: crates/platinum-sdk/src/game/network/prediction.rs:111
platinum_sdk::game::network::prediction::ClientPrediction::presentation_tick
pub fn presentation_tick(&self) -> u64
Tick of remote geometry currently presented, including interpolation delay.
Source: crates/platinum-sdk/src/game/network/prediction.rs:125
platinum_sdk::game::network::prediction::ClientPrediction::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction.rs:131
platinum_sdk::game::network::prediction::ClientPrediction::pending_inputs
pub fn pending_inputs(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction.rs:134
platinum_sdk::game::network::prediction::ClientPrediction::reconcile
pub fn reconcile(
&mut self,
session: &mut FpsSession,
snapshot: WorldSnapshot,
local: PlayerId,
ack: u64,
) -> Result<(), String>
Apply a validated baseline, discard acknowledged inputs and replay the remainder.
Source: crates/platinum-sdk/src/game/network/prediction.rs:138
platinum_sdk::game::network::prediction::ClientPrediction::predict
pub fn predict(&mut self, session: &mut FpsSession, dt: f32, input: GameInput, sequence: u64)
Consume the same numbered input sent to the authority. Called every render
frame, including frames without a received snapshot, for responsive mouse aim.
Source: crates/platinum-sdk/src/game/network/prediction.rs:214
platinum_sdk::game::network::prediction_objects
platinum_sdk::game::network::prediction_objects
Snapshot-only render transforms for moving scene objects. Authority collision
components and scene transforms are never mutated by this interpolation layer.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:1
platinum_sdk::game::network::prediction_objects::MAX_INTERPOLATED_OBJECTS
pub const MAX_INTERPOLATED_OBJECTS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:6
platinum_sdk::game::network::prediction_objects::MAX_OBJECT_SAMPLES
pub const MAX_OBJECT_SAMPLES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:7
platinum_sdk::game::network::prediction_objects::ObjectInterpolation
pub struct ObjectInterpolation
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:15
platinum_sdk::game::network::prediction_objects::ObjectInterpolation::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:20
platinum_sdk::game::network::prediction_objects::ObjectInterpolation::tracked_objects
pub fn tracked_objects(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:23
platinum_sdk::game::network::prediction_objects::ObjectInterpolation::accept
pub fn accept(&mut self, epoch: u64, tick: u64, objects: &[SceneObject], hidden: &[u64])
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:26
platinum_sdk::game::network::prediction_objects::ObjectInterpolation::sample
pub fn sample(&self, time: f64, output: &mut BTreeMap<u64, Transform>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/prediction_objects.rs:79
platinum_sdk::game::network::signaling
platinum_sdk::game::network::signaling
Room-scoped Matchbox signaling. Game packets go over WebRTC, not this service.
Source: crates/platinum-sdk/src/game/network/signaling.rs:1
platinum_sdk::game::network::signaling::SignalingServer
pub struct SignalingServer
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| address | std::net::SocketAddr | |
Source: crates/platinum-sdk/src/game/network/signaling.rs:21
platinum_sdk::game::network::signaling::SignalingServer::bind
pub fn bind(address: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/signaling.rs:26
platinum_sdk::game::network::signaling::SignalingServer::shutdown
pub fn shutdown(&self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/signaling.rs:62
platinum_sdk::game::network::webtransport
platinum_sdk::game::network::webtransport
Encrypted UDP/QUIC WebTransport, with reliable controls and latest-state datagrams.
Source: crates/platinum-sdk/src/game/network/webtransport/mod.rs:1
platinum_sdk::game::network::webtransport::parse_endpoint
pub fn parse_endpoint(endpoint: &str) -> Result<(String, Option<[u8; 32]>), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/mod.rs:12
platinum_sdk::game::network::webtransport::Connection
pub struct Connection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ConnectionState | |
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:17
platinum_sdk::game::network::webtransport::Connection::connect
pub fn connect(endpoint: &str, name: &str, secret: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:32
platinum_sdk::game::network::webtransport::Connection::connect_project
pub fn connect_project(
endpoint: &str,
name: &str,
secret: &str,
project_hash: &str,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:35
platinum_sdk::game::network::webtransport::Connection::poll
pub fn poll(&mut self) -> Result<Vec<ServerPacket>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:82
platinum_sdk::game::network::webtransport::Connection::send_input
pub fn send_input(&mut self, input: GameInput) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:175
platinum_sdk::game::network::webtransport::Connection::send_input_at
pub fn send_input_at(&mut self, input: GameInput, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:178
platinum_sdk::game::network::webtransport::Connection::input_sequence
pub fn input_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:198
platinum_sdk::game::network::webtransport::Connection::prediction_sequence
pub fn prediction_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:201
platinum_sdk::game::network::webtransport::Connection::ready
pub fn ready(&mut self, epoch: u64, project_hash: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:204
platinum_sdk::game::network::webtransport::Connection::lobby_ready
pub fn lobby_ready(&mut self, ready: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:210
platinum_sdk::game::network::webtransport::Connection::ui_action
pub fn ui_action(&mut self, action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:214
platinum_sdk::game::network::webtransport::Connection::disconnect
pub fn disconnect(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/browser.rs:227
platinum_sdk::game::network::webtransport::codec
platinum_sdk::game::network::webtransport::codec
Bounded framing shared by native QUIC and browser WebTransport adapters.
Snapshot datagrams are disposable presentation state; reliable frames carry JSON messages.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:1
platinum_sdk::game::network::webtransport::codec::DATAGRAM_HEADER_BYTES
pub const DATAGRAM_HEADER_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:5
platinum_sdk::game::network::webtransport::codec::MAX_SNAPSHOT_BYTES
pub const MAX_SNAPSHOT_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:6
platinum_sdk::game::network::webtransport::codec::MAX_FRAGMENT_BYTES
pub const MAX_FRAGMENT_BYTES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:7
platinum_sdk::game::network::webtransport::codec::MAX_FRAGMENTS
pub const MAX_FRAGMENTS: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:8
platinum_sdk::game::network::webtransport::codec::SnapshotMetadata
pub struct SnapshotMetadata
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| serial | u64 | |
| epoch | u64 | |
| tick | u64 | |
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:13
platinum_sdk::game::network::webtransport::codec::fragment_snapshot
pub fn fragment_snapshot(
serial: u64,
epoch: u64,
tick: u64,
text: &str,
max_datagram_size: usize,
) -> Result<Vec<Vec<u8>>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:24
platinum_sdk::game::network::webtransport::codec::SnapshotAssembler
pub struct SnapshotAssembler
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:71
platinum_sdk::game::network::webtransport::codec::SnapshotAssembler::latest
pub fn latest(&self) -> Option<SnapshotMetadata>
Metadata for the last complete snapshot returned by `push`.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:78
platinum_sdk::game::network::webtransport::codec::SnapshotAssembler::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:82
platinum_sdk::game::network::webtransport::codec::SnapshotAssembler::push
pub fn push(&mut self, packet: &[u8], now: f64) -> Result<Option<String>, String>
`now` is a monotonic timestamp in seconds, e.g. elapsed time or performance.now()/1000.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:87
platinum_sdk::game::network::webtransport::codec::encode_frame
pub fn encode_frame(text: &str, max: usize) -> Result<Vec<u8>, String>
Reliable frames are a big-endian u32 byte length followed by UTF-8 JSON.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:213
platinum_sdk::game::network::webtransport::codec::FrameDecoder
pub struct FrameDecoder
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:223
platinum_sdk::game::network::webtransport::codec::FrameDecoder::new
pub fn new(max: usize) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:229
platinum_sdk::game::network::webtransport::codec::FrameDecoder::push
pub fn push(&mut self, mut bytes: &[u8]) -> Result<Vec<String>, String>
Consumes arbitrary stream chunks, retaining only one bounded incomplete frame.
Source: crates/platinum-sdk/src/game/network/webtransport/codec.rs:238
platinum_sdk::game::network::webtransport::native
platinum_sdk::game::network::webtransport::native
Native QUIC worker. Gameplay stays on NetworkServer's caller thread.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:1
platinum_sdk::game::network::webtransport::native::WebTransportServerOptions
pub struct WebTransportServerOptions
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bind | SocketAddr | |
| advertise_host | Option<String> | |
| identity_pem | Option<(PathBuf, PathBuf)> | Existing PEM certificate/key paths. None generates an ephemeral in-memory identity. |
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:36
platinum_sdk::game::network::webtransport::native::WebTransportMetadata
pub struct WebTransportMetadata
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| address | SocketAddr | |
| endpoint | String | |
| sha256 | String | |
| transport | String | |
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:43
platinum_sdk::game::network::webtransport::native::Connection
pub struct Connection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ConnectionState | |
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:268
platinum_sdk::game::network::webtransport::native::Connection::connect_project
pub fn connect_project(
endpoint: &str,
name: &str,
secret: &str,
hash: &str,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:283
platinum_sdk::game::network::webtransport::native::Connection::poll
pub fn poll(&mut self) -> Result<Vec<ServerPacket>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:339
platinum_sdk::game::network::webtransport::native::Connection::send_input_at
pub fn send_input_at(&mut self, input: GameInput, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:392
platinum_sdk::game::network::webtransport::native::Connection::send_input
pub fn send_input(&mut self, input: GameInput) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:427
platinum_sdk::game::network::webtransport::native::Connection::prediction_sequence
pub fn prediction_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:430
platinum_sdk::game::network::webtransport::native::Connection::input_sequence
pub fn input_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:433
platinum_sdk::game::network::webtransport::native::Connection::ready
pub fn ready(&mut self, epoch: u64, hash: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:436
platinum_sdk::game::network::webtransport::native::Connection::lobby_ready
pub fn lobby_ready(&mut self, ready: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:442
platinum_sdk::game::network::webtransport::native::Connection::ui_action
pub fn ui_action(&mut self, action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:446
platinum_sdk::game::network::webtransport::native::Connection::disconnect
pub fn disconnect(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/webtransport/native.rs:457
platinum_sdk::game::network::NetworkTrafficStats
pub struct NetworkTrafficStats
JSON payload counters; excludes WebSocket/TCP/TLS framing and retransmission.
Transmit counts successful queue acceptance, not confirmed socket delivery.
Public data fields| Name | Type / declaration | Description |
|---|
| tx_queued_bytes | u64 | |
| tx_queued_messages | u64 | |
| tx_rejected_messages | u64 | |
| rx_json_bytes | u64 | |
| rx_json_messages | u64 | |
| quic_udp_tx_bytes | u64 | QUIC's measured UDP bytes/datagrams include encryption, framing and retransmission. |
| quic_udp_rx_bytes | u64 | |
| quic_udp_tx_datagrams | u64 | |
| quic_udp_rx_datagrams | u64 | |
Source: crates/platinum-sdk/src/game/network/native.rs:42
platinum_sdk::game::network::NetworkServer
pub struct NetworkServer
Threaded I/O only; all gameplay/world/Lua mutation stays on the authority caller's thread.
Public data fields| Name | Type / declaration | Description |
|---|
| protocol | AuthorityProtocol | |
| local_addr | std::net::SocketAddr | |
Source: crates/platinum-sdk/src/game/network/native.rs:68
platinum_sdk::game::network::NetworkServer::bind
pub fn bind(address: &str, config: ServerConfig) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:83
platinum_sdk::game::network::NetworkServer::update
pub fn update(&mut self, session: &mut FpsSession, dt: f32, local_input: Option<GameInput>)
Poll transport, apply validated input, step one authority, then broadcast at configured rate.
Source: crates/platinum-sdk/src/game/network/native.rs:146
platinum_sdk::game::network::NetworkServer::traffic_stats
pub fn traffic_stats(&self) -> NetworkTrafficStats
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:237
platinum_sdk::game::network::NetworkServer::enable_webtransport
pub fn enable_webtransport(
&mut self,
options: super::webtransport::WebTransportServerOptions,
) -> Result<super::webtransport::WebTransportMetadata, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:267
platinum_sdk::game::network::NetworkServer::shutdown
pub fn shutdown(&mut self, session: &mut FpsSession)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:283
platinum_sdk::game::network::NetworkServer::start_round
pub fn start_round(&mut self, session: &mut FpsSession) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:290
platinum_sdk::game::network::Connection
pub struct Connection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ConnectionState | |
Source: crates/platinum-sdk/src/game/network/native.rs:383
platinum_sdk::game::network::Connection::connect
pub fn connect(endpoint: &str, name: &str, secret: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:394
platinum_sdk::game::network::Connection::connect_project
pub fn connect_project(
endpoint: &str,
name: &str,
secret: &str,
project_hash: &str,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:397
platinum_sdk::game::network::Connection::poll
pub fn poll(&mut self) -> Result<Vec<ServerPacket>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:467
platinum_sdk::game::network::Connection::send_input
pub fn send_input(&mut self, input: GameInput) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:519
platinum_sdk::game::network::Connection::send_input_at
pub fn send_input_at(&mut self, input: GameInput, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:522
platinum_sdk::game::network::Connection::input_sequence
pub fn input_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:542
platinum_sdk::game::network::Connection::prediction_sequence
pub fn prediction_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:545
platinum_sdk::game::network::Connection::ready
pub fn ready(&mut self, epoch: u64, project_hash: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:548
platinum_sdk::game::network::Connection::lobby_ready
pub fn lobby_ready(&mut self, ready: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:554
platinum_sdk::game::network::Connection::ui_action
pub fn ui_action(&mut self, action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:558
platinum_sdk::game::network::Connection::disconnect
pub fn disconnect(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/native.rs:571
platinum_sdk::game::network::Connection
pub struct Connection
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| state | ConnectionState | |
Source: crates/platinum-sdk/src/game/network/browser.rs:16
platinum_sdk::game::network::Connection::connect
pub fn connect(endpoint: &str, name: &str, secret: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:27
platinum_sdk::game::network::Connection::connect_project
pub fn connect_project(
endpoint: &str,
name: &str,
secret: &str,
project_hash: &str,
) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:30
platinum_sdk::game::network::Connection::poll
pub fn poll(&mut self) -> Result<Vec<ServerPacket>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:119
platinum_sdk::game::network::Connection::send_input
pub fn send_input(&mut self, input: GameInput) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:164
platinum_sdk::game::network::Connection::send_input_at
pub fn send_input_at(&mut self, input: GameInput, tick: u64) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:167
platinum_sdk::game::network::Connection::input_sequence
pub fn input_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:187
platinum_sdk::game::network::Connection::prediction_sequence
pub fn prediction_sequence(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:190
platinum_sdk::game::network::Connection::ready
pub fn ready(&mut self, epoch: u64, project_hash: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:193
platinum_sdk::game::network::Connection::lobby_ready
pub fn lobby_ready(&mut self, ready: bool) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:199
platinum_sdk::game::network::Connection::ui_action
pub fn ui_action(&mut self, action: &str, value: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:203
platinum_sdk::game::network::Connection::disconnect
pub fn disconnect(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/network/browser.rs:216
platinum_sdk::game::ui
platinum_sdk::game::ui
Retained game UI. Documents and transactions are independent of the renderer.
Source: crates/platinum-sdk/src/game/ui/mod.rs:1
platinum_sdk::game::ui::UiCommand
pub enum UiCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/mod.rs:19
platinum_sdk::game::ui::UiRequest
pub struct UiRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| player | crate::game::PlayerId | |
| command | UiCommand | |
Source: crates/platinum-sdk/src/game/ui/mod.rs:35
platinum_sdk::game::ui::DEFAULT_HUD_XML
pub const DEFAULT_HUD_XML: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/mod.rs:40
platinum_sdk::game::ui::DEFAULT_PAUSE_XML
pub const DEFAULT_PAUSE_XML: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/mod.rs:41
platinum_sdk::game::ui::UiProperty
pub enum UiProperty
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:10
platinum_sdk::game::ui::UiProperty::parse
pub fn parse(path: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:21
platinum_sdk::game::ui::UiProperty::attribute
pub fn attribute(self) -> &'static str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:34
platinum_sdk::game::ui::UiTarget
pub struct UiTarget
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| screen | u64 | |
| element | UiElementId | |
Source: crates/platinum-sdk/src/game/ui/binding.rs:55
platinum_sdk::game::ui::UiAnimationBindings
pub struct UiAnimationBindings
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:60
platinum_sdk::game::ui::UiAnimationBindings::set
pub fn set(
&mut self,
target: UiTarget,
property: UiProperty,
value: f32,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:65
platinum_sdk::game::ui::UiAnimationBindings::clear
pub fn clear(&mut self, target: UiTarget)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:83
platinum_sdk::game::ui::UiAnimationBindings::clear_screen
pub fn clear_screen(&mut self, screen: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:87
platinum_sdk::game::ui::UiAnimationBindings::apply_samples
pub fn apply_samples(
&mut self,
screen: u64,
samples: &[AnimationSample],
objects: &BTreeMap<String, UiElementId>,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:91
platinum_sdk::game::ui::UiAnimationBindings::values
pub fn values(&self, target: UiTarget, element: &UiElement) -> BTreeMap<UiProperty, f32>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:126
platinum_sdk::game::ui::UiAnimationBindings::effective_opacity
pub fn effective_opacity(
&self,
screen: u64,
id: u64,
document: &UiDocument,
inputs: &BTreeMap<String, String>,
) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/binding.rs:147
platinum_sdk::game::ui::UiElementId
pub type UiElementId
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:4
platinum_sdk::game::ui::UiElement
pub struct UiElement
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | UiElementId | |
| parent | Option<UiElementId> | |
| kind | String | |
| attributes | BTreeMap<String, String> | |
| text | String | |
Source: crates/platinum-sdk/src/game/ui/document.rs:6
platinum_sdk::game::ui::UiElement::number
pub fn number(&self, name: &str, fallback: f32) -> f32
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:14
platinum_sdk::game::ui::UiElement::rect
pub fn rect(&self) -> [f32; 4]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:21
platinum_sdk::game::ui::UiElement::set_rect
pub fn set_rect(&mut self, rect: [f32; 4])
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:29
platinum_sdk::game::ui::UiDocument
pub struct UiDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| name | String | |
| size | [f32; 2] | |
| stylesheet | String | |
| elements | Vec<UiElement> | |
| comments | Vec<String> | |
Source: crates/platinum-sdk/src/game/ui/document.rs:36
platinum_sdk::game::ui::UiDocument::parse
pub fn parse(xml: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:45
platinum_sdk::game::ui::UiDocument::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:115
platinum_sdk::game::ui::UiDocument::to_xml
pub fn to_xml(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:166
platinum_sdk::game::ui::UiDocument::next_id
pub fn next_id(&self) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:206
platinum_sdk::game::ui::UiDocument::dependencies
pub fn dependencies(&self) -> BTreeSet<String>
Paths relative to this UI document, for export dependency closure.
Source: crates/platinum-sdk/src/game/ui/document.rs:216
platinum_sdk::game::ui::UiStylesheet
pub struct UiStylesheet
Bounded selectors: kind, .class, #integer-id and their :hover/:pressed states.
Public data fields| Name | Type / declaration | Description |
|---|
| rules | Vec<(String, BTreeMap<String, String>)> | |
Source: crates/platinum-sdk/src/game/ui/document.rs:236
platinum_sdk::game::ui::UiStylesheet::parse
pub fn parse(css: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:240
platinum_sdk::game::ui::UiStylesheet::resolve
pub fn resolve(&self, e: &UiElement, state: &str) -> BTreeMap<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:329
platinum_sdk::game::ui::UiHistory
pub struct UiHistory
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:364
platinum_sdk::game::ui::UiHistory::commit
pub fn commit(&mut self, before: UiDocument, after: &UiDocument)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:369
platinum_sdk::game::ui::UiHistory::undo
pub fn undo(&mut self, doc: &mut UiDocument) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:378
platinum_sdk::game::ui::UiHistory::redo
pub fn redo(&mut self, doc: &mut UiDocument) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:386
platinum_sdk::game::ui::UiOverrides
pub struct UiOverrides(pub BTreeMap<UiElementId, BTreeMap<String, String>>)
Per-instance property overrides; source updates flow through all untouched properties.
Source: crates/platinum-sdk/src/game/ui/document.rs:398
platinum_sdk::game::ui::UiOverrides::instantiate
pub fn instantiate(&self, source: &UiDocument) -> UiDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:400
platinum_sdk::game::ui::UiOverrides::apply_to
pub fn apply_to(&mut self, source: &mut UiDocument) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:419
platinum_sdk::game::ui::UiOverrides::revert
pub fn revert(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:426
platinum_sdk::game::ui::UiInstanceAsset
pub struct UiInstanceAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| source | String | |
| overrides | UiOverrides | |
Source: crates/platinum-sdk/src/game/ui/document.rs:432
platinum_sdk::game::ui::UiOverrides::between
pub fn between(source: &UiDocument, instance: &UiDocument) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/document.rs:438
platinum_sdk::game::ui::UiClipboard
pub struct UiClipboard
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| roots | Vec<u64> | |
| elements | Vec<UiElement> | |
Source: crates/platinum-sdk/src/game/ui/edit.rs:7
platinum_sdk::game::ui::UiAlignment
pub enum UiAlignment
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/edit.rs:13
platinum_sdk::game::ui::UiObject
pub struct UiObject
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| screen | u64 | |
| id | UiElementId | |
| action | String | |
| binding | String | |
| kind | String | |
| source_text | String | |
| attributes | BTreeMap<String, String> | |
Source: crates/platinum-sdk/src/game/ui/runtime.rs:14
platinum_sdk::game::ui::GameUiRuntime
pub struct GameUiRuntime
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| screens | Vec<UiScreen> | |
| values | BTreeMap<String, String> | |
| local_player | u64 | |
| tick | u64 | |
| input_generation | u64 | Transition generation; gameplay releases capture and clears held input on change. |
Source: crates/platinum-sdk/src/game/ui/runtime.rs:34
platinum_sdk::game::ui::UiScreen
pub struct UiScreen
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| document | UiDocument | |
| styles | UiStylesheet | |
| modal | bool | |
| asset | String | |
| effective | UiDocument | |
Source: crates/platinum-sdk/src/game/ui/runtime.rs:50
platinum_sdk::game::ui::GameUiRuntime::open
pub fn open(
&mut self,
document: UiDocument,
styles: UiStylesheet,
modal: bool,
) -> Result<u64, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:94
platinum_sdk::game::ui::GameUiRuntime::open_asset
pub fn open_asset(
&mut self,
path: &str,
document: UiDocument,
styles: UiStylesheet,
modal: bool,
) -> Result<u64, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:116
platinum_sdk::game::ui::GameUiRuntime::screen_for_document
pub fn screen_for_document(&self, path: &str) -> Option<u64>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:145
platinum_sdk::game::ui::GameUiRuntime::get_widget
pub fn get_widget(&self, target: &UiWidgetRef, property: &str) -> Result<UiScalar, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:152
platinum_sdk::game::ui::GameUiRuntime::patch_widget
pub fn patch_widget(
&mut self,
target: &UiWidgetRef,
patch: &UiWidgetPatch,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:169
platinum_sdk::game::ui::GameUiRuntime::apply_persistent
pub fn apply_persistent(&mut self, state: &UiPlayerState) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:197
platinum_sdk::game::ui::GameUiRuntime::pop
pub fn pop(&mut self) -> Option<UiScreen>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:229
platinum_sdk::game::ui::GameUiRuntime::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:238
platinum_sdk::game::ui::GameUiRuntime::set_value
pub fn set_value(&mut self, name: impl Into<String>, value: impl ToString)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:244
platinum_sdk::game::ui::GameUiRuntime::blocks_gameplay
pub fn blocks_gameplay(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:252
platinum_sdk::game::ui::GameUiRuntime::invalidate
pub fn invalidate(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:255
platinum_sdk::game::ui::UiAction
pub struct UiAction
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| event | String | |
| screen | u64 | |
| element | UiElementId | |
| action | String | |
| value | String | |
| player | u64 | |
| tick | u64 | |
| sequence | u64 | |
Source: crates/platinum-sdk/src/game/ui/runtime.rs:301
platinum_sdk::game::ui::UiActionQueue
pub struct UiActionQueue
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| actions | Vec<UiAction> | |
Source: crates/platinum-sdk/src/game/ui/runtime.rs:312
platinum_sdk::game::ui::UiActivation
pub struct UiActivation(pub UiAction)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:318
platinum_sdk::game::ui::UiActionQueue::drain
pub fn drain(&mut self) -> impl Iterator<Item
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:320
platinum_sdk::game::ui::GameUiPlugin
pub struct GameUiPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:324
platinum_sdk::game::ui::ui_color
pub fn ui_color(value: &str, fallback: Color) -> Color
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/runtime.rs:359
platinum_sdk::game::ui::GameUserSettings
pub struct GameUserSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| master_volume | f32 | |
| muted | bool | |
Source: crates/platinum-sdk/src/game/ui/settings.rs:6
platinum_sdk::game::ui::GameUserSettings::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/settings.rs:21
platinum_sdk::game::ui::FRAMEWORK_MAIN_MENU
pub const FRAMEWORK_MAIN_MENU: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:7
platinum_sdk::game::ui::FRAMEWORK_HUD
pub const FRAMEWORK_HUD: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:8
platinum_sdk::game::ui::FRAMEWORK_PAUSE
pub const FRAMEWORK_PAUSE: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:9
platinum_sdk::game::ui::FRAMEWORK_LOBBY
pub const FRAMEWORK_LOBBY: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:10
platinum_sdk::game::ui::FRAMEWORK_SETTINGS
pub const FRAMEWORK_SETTINGS: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:11
platinum_sdk::game::ui::FRAMEWORK_RESULTS
pub const FRAMEWORK_RESULTS: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:12
platinum_sdk::game::ui::UiWidgetRef
pub struct UiWidgetRef
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| document | String | |
| element | u64 | |
Source: crates/platinum-sdk/src/game/ui/state.rs:15
platinum_sdk::game::ui::UiWidgetRef::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:36
platinum_sdk::game::ui::UiScalar
pub enum UiScalar
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:48
platinum_sdk::game::ui::UiScalar::to_json
pub fn to_json(&self) -> serde_json::Value
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:54
platinum_sdk::game::ui::UiScalar::text
pub fn text(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:61
platinum_sdk::game::ui::WIDGET_PROPERTIES
pub const WIDGET_PROPERTIES: &[&str]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:69
platinum_sdk::game::ui::widget_property
pub fn widget_property(name: &str) -> Result<&'static str, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:88
platinum_sdk::game::ui::UiWidgetPatch
pub struct UiWidgetPatch
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| properties | BTreeMap<String, UiScalar> | |
Source: crates/platinum-sdk/src/game/ui/state.rs:100
platinum_sdk::game::ui::UiWidgetPatch::normalized
pub fn normalized(&self) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:104
platinum_sdk::game::ui::UiWidgetPatch::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:149
platinum_sdk::game::ui::UiWidgetPatch::apply_to_element
pub fn apply_to_element(&self, element: &mut UiElement)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:152
platinum_sdk::game::ui::UiQueryView
pub type UiQueryView
Keys serialize widget IDs as JSON object keys, never floating-point values.
Source: crates/platinum-sdk/src/game/ui/state.rs:184
platinum_sdk::game::ui::UiPlayerState
pub struct UiPlayerState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| revision | u64 | |
| widgets | BTreeMap<String, BTreeMap<u64, UiWidgetPatch>> | |
| values | BTreeMap<String, String> | |
Source: crates/platinum-sdk/src/game/ui/state.rs:186
platinum_sdk::game::ui::UiPlayerState::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:195
platinum_sdk::game::ui::UiWidgetState
pub struct UiWidgetState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| target | UiWidgetRef | |
| parent | Option<u64> | |
| kind | String | |
| properties | BTreeMap<String, UiScalar> | |
Source: crates/platinum-sdk/src/game/ui/state.rs:230
platinum_sdk::game::ui::UiState
pub struct UiState
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:237
platinum_sdk::game::ui::UiState::from_project
pub fn from_project(root: &Path, project: &crate::game::GameProject) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:247
platinum_sdk::game::ui::UiState::register
pub fn register(&mut self, path: &str, document: UiDocument) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:330
platinum_sdk::game::ui::UiState::register_styled
pub fn register_styled(
&mut self,
path: &str,
document: UiDocument,
styles: UiStylesheet,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:333
platinum_sdk::game::ui::UiState::ensure_document
pub fn ensure_document(&mut self, root: &Path, path: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:361
platinum_sdk::game::ui::UiState::documents
pub fn documents(&self) -> &BTreeMap<String, UiDocument>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:407
platinum_sdk::game::ui::UiState::player_snapshot
pub fn player_snapshot(&self, source: u64) -> UiPlayerState
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:410
platinum_sdk::game::ui::UiState::apply_player_snapshot
pub fn apply_player_snapshot(
&mut self,
source: u64,
mut state: UiPlayerState,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:448
platinum_sdk::game::ui::UiState::remove_player
pub fn remove_player(&mut self, source: u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:480
platinum_sdk::game::ui::UiState::replace_player_snapshots
pub fn replace_player_snapshots(
&mut self,
states: BTreeMap<u64, UiPlayerState>,
) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:484
platinum_sdk::game::ui::UiState::apply
pub fn apply(&mut self, source: u64, command: &UiCommand) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:513
platinum_sdk::game::ui::UiState::query_revision
pub fn query_revision(&self, source: u64) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:551
platinum_sdk::game::ui::UiState::query_view
pub fn query_view(&mut self, source: u64) -> &UiQueryView
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:558
platinum_sdk::game::ui::UiState::get
pub fn get(
&mut self,
source: u64,
target: &UiWidgetRef,
property: &str,
) -> Result<UiScalar, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:590
platinum_sdk::game::ui::widget_properties
pub fn widget_properties(
document: &UiDocument,
element: &UiElement,
styles: &UiStylesheet,
values: &BTreeMap<String, String>,
) -> BTreeMap<String, UiScalar>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:607
platinum_sdk::game::ui::patch_query_view
pub fn patch_query_view(
view: &mut UiQueryView,
target: &UiWidgetRef,
patch: &UiWidgetPatch,
) -> Result<(), String>
Apply to a canonical query mirror, including inherited flags, before queued commands drain.
Source: crates/platinum-sdk/src/game/ui/state.rs:698
platinum_sdk::game::ui::widget_flag
pub fn widget_flag(
document: &UiDocument,
id: u64,
styles: &UiStylesheet,
values: &BTreeMap<String, String>,
enabled: bool,
) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/ui/state.rs:748
platinum_sdk::game::ui::UiViewportPolicy
pub enum UiViewportPolicy
Fit preserves authored proportions in logical pixels; Responsive lays out against
the actual window, using the document's anchors/percentages/flex/grid rules.
Source: crates/platinum-sdk/src/game/ui/viewport.rs:5
platinum_sdk::game::ui::design_viewport
pub fn design_viewport(
design: [f32; 2],
viewport: Vec2,
policy: UiViewportPolicy,
) -> ([f32; 4], f32)
Node rectangle and transform scale. DPI is handled by Bevy after these logical units.
Source: crates/platinum-sdk/src/game/ui/viewport.rs:11
platinum_sdk::game::GameplayAssetsPlugin
pub struct GameplayAssetsPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/assets.rs:7
platinum_sdk::game::material
platinum_sdk::game::material
Portable procedural PBR documents. The renderer executes graphs in three dimensions on the GPU.
Source: crates/platinum-sdk/src/game/material.rs:1
platinum_sdk::game::material::MaterialOverrides
pub struct MaterialOverrides
Sparse per-instance graph parameters. Stable node IDs retain overrides across asset edits.
Public data fields| Name | Type / declaration | Description |
|---|
| nodes | BTreeMap<u64, MaterialOp> | |
Source: crates/platinum-sdk/src/game/material.rs:9
platinum_sdk::game::material::MaterialOverrides::resolve
pub fn resolve(&self, source: &MaterialAsset) -> Result<MaterialAsset, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:14
platinum_sdk::game::material::MaterialOverrides::apply
pub fn apply(&mut self, source: &mut MaterialAsset) -> Result<(), String>
Returns an upstream document; callers save it transactionally before clearing overrides.
Source: crates/platinum-sdk/src/game/material.rs:36
platinum_sdk::game::material::MaterialOverrides::revert
pub fn revert(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:89
platinum_sdk::game::material::Pattern
pub enum Pattern
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:96
platinum_sdk::game::material::MaterialComponent
pub struct MaterialComponent
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| pattern | Pattern | |
| scale | f32 | |
| seed | u32 | |
| contrast | f32 | |
| colors | [[f32; 3]; 2] | |
| weight | f32 | |
Source: crates/platinum-sdk/src/game/material.rs:103
platinum_sdk::game::material::SimpleMaterial
pub struct SimpleMaterial
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| components | Vec<MaterialComponent> | |
| roughness | f32 | |
| metallic | f32 | |
| bump | f32 | |
Source: crates/platinum-sdk/src/game/material.rs:113
platinum_sdk::game::material::MaterialOp
pub enum MaterialOp
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:139
platinum_sdk::game::material::MaterialOp::label
pub fn label(&self) -> &'static str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:172
platinum_sdk::game::material::MaterialOp::inputs
pub fn inputs(&self) -> &'static [&'static str]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:185
platinum_sdk::game::material::MaterialOp::outputs
pub fn outputs(&self) -> &'static [&'static str]
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:195
platinum_sdk::game::material::MaterialNode
pub struct MaterialNode
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| op | MaterialOp | |
Source: crates/platinum-sdk/src/game/material.rs:207
platinum_sdk::game::material::MaterialWire
pub struct MaterialWire
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| from | u64 | |
| to | u64 | |
| input | usize | |
Source: crates/platinum-sdk/src/game/material.rs:212
platinum_sdk::game::material::MaterialGraph
pub struct MaterialGraph
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| nodes | Vec<MaterialNode> | |
| wires | Vec<MaterialWire> | |
| positions | BTreeMap<u64, [f32; 2]> | |
Source: crates/platinum-sdk/src/game/material.rs:218
platinum_sdk::game::material::SimpleMaterial::graph
pub fn graph(&self) -> MaterialGraph
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:226
platinum_sdk::game::material::MaterialAsset
pub struct MaterialAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| name | String | |
| simple | Option<SimpleMaterial> | Only Simple mode regenerates the graph. Converting to Graph is explicit and non-destructive. |
| graph | MaterialGraph | |
Source: crates/platinum-sdk/src/game/material.rs:314
platinum_sdk::game::material::MaterialAsset::bake_key
pub fn bake_key(&self) -> String
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:333
platinum_sdk::game::material::MaterialAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:338
platinum_sdk::game::material::MaterialAsset::effective_graph
pub fn effective_graph(&self) -> MaterialGraph
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:343
platinum_sdk::game::material::MaterialAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:348
platinum_sdk::game::material::MaterialAsset::bake
pub fn bake(&self, size: u32) -> Result<BakedMaterial, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:371
platinum_sdk::game::material::BakedMaterial
pub struct BakedMaterial
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| size | u32 | |
| color | Vec<u8> | |
| packed | Vec<u8> | |
| normal | Vec<u8> | |
Source: crates/platinum-sdk/src/game/material.rs:481
platinum_sdk::game::material::MaterialGraph::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material.rs:580
platinum_sdk::game::material_gpu
platinum_sdk::game::material_gpu
Uniform graph program executed per fragment. No UVs, generated images, or per-frame CPU baking.
Source: crates/platinum-sdk/src/game/material_gpu.rs:1
platinum_sdk::game::material_gpu::GraphProgram
pub struct GraphProgram
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| header | Vec4 | |
| inputs | [Vec4; 64] | |
| a | [Vec4; 64] | |
| b | [Vec4; 64] | |
Source: crates/platinum-sdk/src/game/material_gpu.rs:10
platinum_sdk::game::material_gpu::ProceduralExtension
pub struct ProceduralExtension
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| program | GraphProgram | |
Source: crates/platinum-sdk/src/game/material_gpu.rs:17
platinum_sdk::game::material_gpu::ProceduralMaterial
pub type ProceduralMaterial
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material_gpu.rs:21
platinum_sdk::game::material_gpu::compile
pub fn compile(asset: &MaterialAsset) -> Result<ProceduralMaterial, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material_gpu.rs:29
platinum_sdk::game::MaterialAssetPrefix
pub struct MaterialAssetPrefix(pub String)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/material_render.rs:11
platinum_sdk::game::AssetPlacement
pub struct AssetPlacement
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| position | [f32; 3] | |
| rotation | [f32; 3] | |
| scale | [f32; 3] | |
Source: crates/platinum-sdk/src/game/prefab.rs:11
platinum_sdk::game::AssetPlacement::transform
pub fn transform(&self) -> Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:26
platinum_sdk::game::AssetPlacement::from_transform
pub fn from_transform(t: Transform) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:36
platinum_sdk::game::AssetInstance
pub struct AssetInstance
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| source | String | |
| root | u64 | |
| source_id | u64 | |
| placement | AssetPlacement | |
| baseline | Value | Last source-local snapshot. Diffs against this preserve edits when source changes. |
| members | Vec<u64> | |
Source: crates/platinum-sdk/src/game/prefab.rs:46
platinum_sdk::game::PrefabAsset
pub struct PrefabAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| name | String | |
| root | u64 | |
| objects | Vec<SceneObject> | |
Source: crates/platinum-sdk/src/game/prefab.rs:57
platinum_sdk::game::InstanceOverrides
pub type InstanceOverrides
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:63
platinum_sdk::game::PrefabAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:248
platinum_sdk::game::PrefabAsset::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:253
platinum_sdk::game::PrefabAsset::from_selection
pub fn from_selection(scene: &SceneDocument, ids: &[u64], name: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:266
platinum_sdk::game::remap_entity_references
pub fn remap_entity_references(value: &mut Value, ids: &BTreeMap<u64, u64>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/prefab.rs:331
platinum_sdk::game::GameLevel
pub struct GameLevel
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| scene | String | |
| events | Option<String> | |
| event_tables | Vec<String> | |
Source: crates/platinum-sdk/src/game/project.rs:6
platinum_sdk::game::GameProject
pub struct GameProject
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| title | String | |
| start_level | String | |
| levels | Vec<GameLevel> | |
| width | u32 | |
| height | u32 | |
| show_menu | bool | |
| preserve_score | bool | |
| framework | FrameworkDefaults | |
| combat | CombatConfig | |
| game_modes | BTreeMap<String, String> | |
| menu_level | Option<String> | |
| menu_camera | MenuCamera | |
| event_catalog | Option<String> | |
| global_events | Vec<String> | |
| mode_events | BTreeMap<String, Vec<String>> | |
Source: crates/platinum-sdk/src/game/project.rs:17
platinum_sdk::game::GameProject::load
pub fn load(root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:64
platinum_sdk::game::GameProject::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:80
platinum_sdk::game::GameProject::level
pub fn level(&self, id: &str) -> Result<&GameLevel, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:147
platinum_sdk::game::GameProject::load_scene
pub fn load_scene(&self, root: &Path, id: &str) -> Result<SceneDocument, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:153
platinum_sdk::game::GamePhase
pub enum GamePhase
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:165
platinum_sdk::game::GameState
pub struct GameState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| phase | GamePhase | |
| level | String | |
| revision | u64 | |
| values | BTreeMap<String, serde_json::Value> | |
| lives | u32 | |
Source: crates/platinum-sdk/src/game/project.rs:172
platinum_sdk::game::LevelRequest
pub struct LevelRequest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| level | String | |
| preserve_score | bool | |
Source: crates/platinum-sdk/src/game/project.rs:191
platinum_sdk::game::read_project_text
pub fn read_project_text(root: &Path, path: &str) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:195
platinum_sdk::game::read_game_text
pub fn read_game_text(path: &Path) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:202
platinum_sdk::game::project_text_exists
pub fn project_text_exists(root: &Path, path: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:222
platinum_sdk::game::project_content_paths
pub fn project_content_paths(root:&Path)->Result<Option<Vec<String>>,String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:226
platinum_sdk::game::read_project_bytes
pub fn read_project_bytes(root:&Path,path:&str)->Result<Vec<u8>,String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:230
platinum_sdk::game::write_prefab
pub fn write_prefab(root: &Path, path: &str, asset: &PrefabAsset) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:245
platinum_sdk::game::MenuCamera
pub struct MenuCamera
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| target | [f32; 3] | |
| radius | f32 | |
| height | f32 | |
| angular_speed | f32 | |
Source: crates/platinum-sdk/src/game/project.rs:276
platinum_sdk::game::MenuCamera::transform
pub fn transform(&self, time: f32) -> bevy::prelude::Transform
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/project.rs:293
platinum_sdk::game::ROOT_SCENE
pub const ROOT_SCENE: &str
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:7
platinum_sdk::game::SceneResidency
pub enum SceneResidency
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:11
platinum_sdk::game::SceneResidency::ticks
pub fn ticks(self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:19
platinum_sdk::game::SceneResidency::renders
pub fn renders(self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:22
platinum_sdk::game::SceneResidency::parse
pub fn parse(value: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:25
platinum_sdk::game::SceneEventScope
pub enum SceneEventScope
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:32
platinum_sdk::game::SceneEventScope::from_script
pub fn from_script(kind: &str, include: &str, exclude: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:46
platinum_sdk::game::SceneEventScope::allows
pub fn allows(&self, own: &str, candidate: &str) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:63
platinum_sdk::game::SceneStreamSettings
pub struct SceneStreamSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| residency | SceneResidency | |
| event_scope | SceneEventScope | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:78
platinum_sdk::game::SceneStreamOverrides
pub struct SceneStreamOverrides
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| residency | Option<SceneResidency> | |
| event_scope | Option<SceneEventScope> | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:84
platinum_sdk::game::SceneStreamSettings::overridden
pub fn overridden(mut self, overrides: &SceneStreamOverrides) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:89
platinum_sdk::game::SceneStreamInstance
pub struct SceneStreamInstance
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reference | String | |
| source | String | |
| placement | AssetPlacement | |
| overrides | SceneStreamOverrides | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:100
platinum_sdk::game::SceneStreamingConfig
pub struct SceneStreamingConfig
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| defaults | SceneStreamSettings | |
| child_defaults | SceneStreamOverrides | |
| instances | Vec<SceneStreamInstance> | |
| event_tables | Vec<String> | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:110
platinum_sdk::game::SceneStreamingConfig::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:117
platinum_sdk::game::SceneMembership
pub struct SceneMembership
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| reference | String | |
| residency | SceneResidency | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:156
platinum_sdk::game::SceneSimulating
pub struct SceneSimulating
Archetype filters for native systems; these are derived, never authored overrides.
Source: crates/platinum-sdk/src/game/scene_residency.rs:162
platinum_sdk::game::ScenePresenting
pub struct ScenePresenting
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:164
platinum_sdk::game::SceneStreamState
pub struct SceneStreamState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| descriptor | SceneStreamInstance | |
| settings | SceneStreamSettings | |
| asset_settings | SceneStreamSettings | |
| child_defaults | SceneStreamOverrides | |
| requested_residency | SceneResidency | |
| members | BTreeSet<u64> | |
| event_tables | Vec<String> | |
| activated | bool | Tracks installed actors so suspending to data retains Lua VM state. |
Source: crates/platinum-sdk/src/game/scene_residency.rs:187
platinum_sdk::game::SceneStreams
pub struct SceneStreams
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| asset_defaults | BTreeMap<String, SceneStreamSettings> | |
| instances | BTreeMap<String, SceneStreamState> | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:203
platinum_sdk::game::SceneCommand
pub enum SceneCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/scene_residency.rs:210
platinum_sdk::game::SceneQueryData
pub struct SceneQueryData
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| entities | BTreeMap<String, Vec<String>> | |
| objects | BTreeMap<String, String> | |
| residency | BTreeMap<String, SceneResidency> | |
Source: crates/platinum-sdk/src/game/scene_residency.rs:650
platinum_sdk::game::GameLaunch
pub struct GameLaunch
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| level | String | |
| mode | String | |
| name | String | |
| host | Option<String> | |
Source: crates/platinum-sdk/src/game/streaming.rs:5
platinum_sdk::game::SceneStreaming
pub struct SceneStreaming
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| status | String | |
| progress | f32 | |
Source: crates/platinum-sdk/src/game/streaming.rs:12
platinum_sdk::game::SceneStreaming::cancel
pub fn cancel(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/streaming.rs:25
platinum_sdk::game::SceneStreaming::busy
pub fn busy(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/streaming.rs:30
platinum_sdk::game::SceneStreaming::launch
pub fn launch(&mut self, launch: GameLaunch)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/streaming.rs:33
platinum_sdk::game::SceneStreaming::menu
pub fn menu(&mut self, project: &GameProject)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/streaming.rs:44
platinum_sdk::game::player
platinum_sdk::game::player
Standalone Bevy game runner shared by Windows and WebGPU/WASM exports.
Source: crates/platinum-sdk/src/game/player.rs:1
platinum_sdk::game::player::SessionMenuRequest
pub enum SessionMenuRequest
Menu intent consumed by session adapters and gameplay scripts, never by layout.
Source: crates/platinum-sdk/src/game/player.rs:31
platinum_sdk::game::player::GameRuntime
pub struct GameRuntime
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| session | FpsSession | |
| root | PathBuf | |
| captured | bool | |
| error | String | |
| local_pause_menu | bool | |
Source: crates/platinum-sdk/src/game/player.rs:39
platinum_sdk::game::player::GameRuntime::override_next_input
pub fn override_next_input(&mut self, input: GameInput)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/player.rs:48
platinum_sdk::game::player::GameCommand
pub enum GameCommand
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/player.rs:53
platinum_sdk::game::player::GameCommandResult
pub struct GameCommandResult
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| operation | String | |
| entities | Vec<u64> | |
| error | Option<String> | |
Source: crates/platinum-sdk/src/game/player.rs:66
platinum_sdk::game::player::GameFrameworkPlugin
pub struct GameFrameworkPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/player.rs:71
platinum_sdk::game::player::GameRenderSettings
pub struct GameRenderSettings
Presentation quality is independent of simulation and project content.
Public data fields| Name | Type / declaration | Description |
|---|
| msaa | Msaa | |
| directional_shadows | bool | |
| beacon_shadows | bool | |
Source: crates/platinum-sdk/src/game/player.rs:74
platinum_sdk::game::player::GameRenderSettings::preset
pub fn preset(name: &str) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/player.rs:80
platinum_sdk::game::player::GamePlayerSystems
pub enum GamePlayerSystems
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/player.rs:110
platinum_sdk::game::player::application
pub fn application(root: PathBuf) -> Result<App, String>
The exported player contains game rendering and menus, never the editor workspace.
Source: crates/platinum-sdk/src/game/player.rs:166
platinum_sdk::game::player::application_with_asset_source
pub fn application_with_asset_source(root:PathBuf,asset_source:Option<bevy::asset::io::AssetSourceBuilder>)->Result<App,String>
Package/bootstrap hosts register their admitted readonly source before the
AssetPlugin is built. Ordinary folder projects keep the normal file source.
Source: crates/platinum-sdk/src/game/player.rs:171
platinum_sdk::game::ExportManifest
pub struct ExportManifest
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| title | String | |
| start_level | String | |
| files | BTreeMap<String, ExportFile> | |
Source: crates/platinum-sdk/src/game/export.rs:5
platinum_sdk::game::ExportFile
pub struct ExportFile
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| bytes | u64 | |
| fingerprint | String | |
Source: crates/platinum-sdk/src/game/export.rs:12
platinum_sdk::game::export_project
pub fn export_project(root: &Path, output: &Path) -> Result<ExportManifest, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/export.rs:17
platinum_sdk::game::SprintSettings
pub struct SprintSettings
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| tactical_speed | f32 | |
| steering_speed | f32 | |
| forward_cone_degrees | f32 | |
| max_look_degrees_per_second | f32 | |
| acceleration | f32 | |
| coast_deceleration | f32 | |
| brake_deceleration | f32 | |
| hard_stop_deceleration | f32 | |
| lateral_acceleration | f32 | |
| double_tap_seconds | f32 | |
Source: crates/platinum-sdk/src/game/locomotion.rs:8
platinum_sdk::game::GearMobility
pub struct GearMobility
Multipliers apply only to held gear. Heavy gear affects acceleration as well as pace.
Public data fields| Name | Type / declaration | Description |
|---|
| movement | f32 | |
| sprint | f32 | |
| tactical | f32 | |
| acceleration | f32 | |
Source: crates/platinum-sdk/src/game/locomotion.rs:39
platinum_sdk::game::SprintMode
pub enum SprintMode
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:57
platinum_sdk::game::SprintState
pub struct SprintState
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| mode | SprintMode | |
| steering | f32 | |
| acceleration | f32 | |
| speed | f32 | |
| strafe_key | u8 | |
Source: crates/platinum-sdk/src/game/locomotion.rs:70
platinum_sdk::game::SprintState::observe
pub fn observe(&mut self, input: GameInput, dt: f32, c: &PlayerController)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:86
platinum_sdk::game::SprintState::advance
pub fn advance(
&mut self,
velocity: Vec3,
yaw: &mut f32,
dt: f32,
c: &PlayerController,
grounded: bool,
crouched: bool,
) -> Vec3
Produces a world velocity. Steering turns heading with a speed-dependent radius.
Source: crates/platinum-sdk/src/game/locomotion.rs:174
platinum_sdk::game::SprintState::sprinting
pub fn sprinting(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:307
platinum_sdk::game::SprintState::braking
pub fn braking(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:313
platinum_sdk::game::gear_controller
pub fn gear_controller(c: &PlayerController, mobility: GearMobility) -> PlayerController
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:318
platinum_sdk::game::step_sprint_controller
pub fn step_sprint_controller(
position: &mut Vec3,
velocity: &mut Vec3,
grounded: &mut bool,
yaw: &mut f32,
state: &mut SprintState,
jump: bool,
dt: f32,
controller: &PlayerController,
crouched: bool,
objects: &[super::SceneObject],
hidden: &std::collections::HashSet<u64>,
) -> bool
Shared authority/prediction step. The hover motor receives the same integrated horizontal velocity.
Source: crates/platinum-sdk/src/game/locomotion.rs:329
platinum_sdk::game::SprintSettings::validate
pub fn validate(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/locomotion.rs:368
platinum_sdk::game::step_character_controller
pub fn step_character_controller(
position: &mut Vec3,
velocity: &mut Vec3,
grounded: &mut bool,
yaw: f32,
movement: Vec2,
sprinting: bool,
jump: bool,
dt: f32,
controller: &PlayerController,
objects: &[SceneObject],
hidden: &HashSet<u64>,
) -> bool
Advance one bounded physics substep. Returns whether this step initiated a jump.
Damage, pickups and inventory never run in client prediction.
Source: crates/platinum-sdk/src/game/controller.rs:7
platinum_sdk::game::character_blocked
pub fn character_blocked(
position: Vec3,
controller: &PlayerController,
objects: &[SceneObject],
hidden: &HashSet<u64>,
) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/controller.rs:69
platinum_sdk::game::resolve_crouch
pub fn resolve_crouch(
requested: bool,
was_crouched: bool,
position: Vec3,
controller: &PlayerController,
objects: &[SceneObject],
hidden: &HashSet<u64>,
) -> bool
Shared authority/prediction stance rules, including clearance when releasing crouch.
Source: crates/platinum-sdk/src/game/controller.rs:108
platinum_sdk::game::stance_controller
pub fn stance_controller(controller: &PlayerController, crouched: bool) -> PlayerController
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/controller.rs:118
platinum_sdk::game::SHOT_HISTORY_FRAMES
pub const SHOT_HISTORY_FRAMES: usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:6
platinum_sdk::game::MAX_HITSCAN_REWIND_SECONDS
pub const MAX_HITSCAN_REWIND_SECONDS: f64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:7
platinum_sdk::game::max_hitscan_rewind_ticks
pub fn max_hitscan_rewind_ticks() -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:8
platinum_sdk::game::ShotHistory
pub struct ShotHistory
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:17
platinum_sdk::game::ShotHistory::clear
pub fn clear(&mut self)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:22
platinum_sdk::game::ShotHistory::len
pub fn len(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:25
platinum_sdk::game::ShotHistory::is_empty
pub fn is_empty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:28
platinum_sdk::game::ShotHistory::clamp_tick
pub fn clamp_tick(now: u64, requested: u64) -> u64
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:31
platinum_sdk::game::ShotHistory::record
pub fn record(
&mut self,
epoch: u64,
tick: u64,
objects: &[SceneObject],
hidden: &HashSet<u64>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:34
platinum_sdk::game::ShotHistory::pose
pub fn pose(&self, object: u64, now: u64, requested: u64) -> Option<Transform>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/lag_compensation.rs:62
platinum_sdk::game::testing
platinum_sdk::game::testing
Project-owned tests: the visual editor, Test Lua and CLI share these assets and runner.
Source: crates/platinum-sdk/src/game/testing.rs:1
platinum_sdk::game::testing::TestCase
pub struct TestCase
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| name | String | |
| module | String | |
| kind | String | |
| targets | Vec<String> | |
| inputs | BTreeMap<String, Value> | |
| source | String | |
| environment | TestEnvironment | |
| event_table | Option<EventTable> | |
| event_table_asset | Option<String> | |
| steps | Vec<TestStep> | |
| expect | Vec<Expectation> | |
| lua_callback | Option<String> | A persisted override can retain its source callback while editing setup/expectations. |
| lua_test_id | Option<String> | |
Source: crates/platinum-sdk/src/game/testing.rs:16
platinum_sdk::game::testing::TestEnvironment
pub struct TestEnvironment
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| scene | Option<String> | Project-relative scene asset, or an inline scene, or a minimal floor/player scene. |
| inline_scene | Option<SceneDocument> | |
| fixture | Option<String> | Project-relative fixture asset, confined to tests/. |
| players | u32 | |
| mode | Option<String> | |
| required_assets | Vec<String> | |
Source: crates/platinum-sdk/src/game/testing.rs:55
platinum_sdk::game::testing::TestStep
pub enum TestStep
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:79
platinum_sdk::game::testing::Expectation
pub struct Expectation
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| channel | String | JSON pointer into the live reflected view; e.g. /world/players/0/score. |
| expected | Value | |
| tolerance | f64 | |
Source: crates/platinum-sdk/src/game/testing.rs:105
platinum_sdk::game::testing::AssertionResult
pub struct AssertionResult
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| channel | String | |
| expected | Value | |
| actual | Option<Value> | |
| passed | bool | |
| message | String | |
Source: crates/platinum-sdk/src/game/testing.rs:113
platinum_sdk::game::testing::Expectation::check
pub fn check(&self, data: &Value) -> AssertionResult
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:121
platinum_sdk::game::testing::TestResult
pub struct TestResult
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| source | String | |
| passed | bool | |
| duration_ms | u128 | |
| assertions | Vec<AssertionResult> | |
| error | Option<String> | |
| outputs | Value | |
Source: crates/platinum-sdk/src/game/testing.rs:172
platinum_sdk::game::testing::TestAsset
pub struct TestAsset
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| tests | Vec<TestCase> | |
Source: crates/platinum-sdk/src/game/testing.rs:183
platinum_sdk::game::testing::TestAsset::parse
pub fn parse(text: &str) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:188
platinum_sdk::game::testing::TestCase::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:207
platinum_sdk::game::testing::CapturedBody
pub struct CapturedBody
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| entity | u64 | |
| velocity | [f32; 3] | |
| angular_velocity | [f32; 3] | |
Source: crates/platinum-sdk/src/game/testing.rs:295
platinum_sdk::game::testing::CapturedTarget
pub struct CapturedTarget
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| entity | u64 | |
| health | f32 | |
| alive | bool | |
| respawn_at | f32 | |
Source: crates/platinum-sdk/src/game/testing.rs:301
platinum_sdk::game::testing::CapturedEventTable
pub struct CapturedEventTable
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| path | String | |
| scene | Option<String> | |
| owner | Option<u64> | |
| table | EventTable | |
Source: crates/platinum-sdk/src/game/testing.rs:308
platinum_sdk::game::testing::TestRuntimeClock
pub struct TestRuntimeClock
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| started | bool | |
| fixed_accumulator | f64 | |
| authority_accumulator | f64 | |
| pending_jump | bool | |
| next_shot | BTreeMap<PlayerId, f32> | |
Source: crates/platinum-sdk/src/game/testing.rs:315
platinum_sdk::game::testing::TestFixture
pub struct TestFixture
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| version | u32 | |
| scene | SceneDocument | |
| world | WorldSnapshot | |
| local_player | PlayerId | |
| lua | BTreeMap<u64, Value> | |
| events | EventTable | |
| event_tables | Vec<CapturedEventTable> | |
| bodies | Vec<CapturedBody> | |
| targets | Vec<CapturedTarget> | |
| required_assets | Vec<String> | |
| clock | TestRuntimeClock | |
| game | GameState | |
| mode_actor | Option<u64> | |
| beacon_angles | BTreeMap<u64, f32> | |
| message | String | |
| message_until | f32 | |
| explosions | u32 | |
| animations | Vec<AnimationPlayback> | |
| project | GameProject | |
| physics_tick | u64 | |
Source: crates/platinum-sdk/src/game/testing.rs:323
platinum_sdk::game::testing::reflected
pub fn reflected(session: &FpsSession) -> Result<Value, String>
The same view is used by assertion channels and the reusable Live Object inspector.
Source: crates/platinum-sdk/src/game/testing.rs:346
platinum_sdk::game::testing::TestFixture::validate
pub fn validate(&self) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:363
platinum_sdk::game::testing::TestFixture::capture
pub fn capture(session: &FpsSession) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:423
platinum_sdk::game::testing::TestFixture::restore
pub fn restore(&self, root: &Path) -> Result<FpsSession, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:557
platinum_sdk::game::testing::minimal_scene
pub fn minimal_scene() -> SceneDocument
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:661
platinum_sdk::game::testing::test_files
pub fn test_files(root: &Path) -> Result<ScopedFiles, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:678
platinum_sdk::game::testing::TestCatalog
pub struct TestCatalog
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| cases | Vec<TestCase> | |
| diagnostics | Vec<String> | |
Source: crates/platinum-sdk/src/game/testing.rs:683
platinum_sdk::game::testing::TestCatalog::discover
pub fn discover(root: &Path) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:688
platinum_sdk::game::testing::run
pub fn run(root: &Path, case: &TestCase) -> TestResult
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing.rs:760
platinum_sdk::game::testing::lua
platinum_sdk::game::testing::lua
Test Lua declarations and callbacks use the same Lua 5.4 engine with no host I/O.
Source: crates/platinum-sdk/src/game/test_lua.rs:1
platinum_sdk::game::testing::lua::discover
pub fn discover(source: &str, name: &str) -> Result<Vec<TestCase>, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/test_lua.rs:191
platinum_sdk::game::testing::TestAssetsPlugin
pub struct TestAssetsPlugin
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_assets.rs:6
platinum_sdk::game::testing_ui
platinum_sdk::game::testing_ui
Reusable automated test editor window. All I/O goes through provisioned test capabilities.
Source: crates/platinum-sdk/src/game/testing_ui.rs:1
platinum_sdk::game::testing_ui::TestRunnerEditor
pub struct TestRunnerEditor
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| open | bool | |
| status | String | |
| catalog | TestCatalog | |
| saved_assets | Vec<String> | |
Source: crates/platinum-sdk/src/game/testing_ui.rs:20
platinum_sdk::game::testing_ui::TestRunnerEditor::open_fixture
pub fn open_fixture(&mut self, root: &Path, path: &str) -> Result<(), String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_ui.rs:47
platinum_sdk::game::testing_ui::TestRunnerEditor::open_source
pub fn open_source(&mut self, root: &Path, source: Option<&str>, run_tests: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_ui.rs:81
platinum_sdk::game::testing_ui::TestRunnerEditor::refresh
pub fn refresh(&mut self, root: &Path)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_ui.rs:128
platinum_sdk::game::testing_ui::TestRunnerEditor::capture
pub fn capture(&mut self, root: &Path, session: &super::FpsSession) -> Result<String, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_ui.rs:149
platinum_sdk::game::testing_ui::TestRunnerEditor::show
pub fn show(&mut self, ctx: &egui::Context, root: &Path)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/game/testing_ui.rs:301
platinum_sdk::node_editor
platinum_sdk::node_editor
Shared, domain-neutral graph canvas. Documents own topology and undo; the canvas owns navigation.
Source: crates/platinum-sdk/src/node_editor.rs:1
platinum_sdk::node_editor::Node
pub struct Node
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | u64 | |
| title | String | |
| subtitle | String | |
| inputs | Vec<String> | |
| outputs | Vec<String> | |
| color | Color32 | |
Source: crates/platinum-sdk/src/node_editor.rs:5
platinum_sdk::node_editor::Link
pub struct Link
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| from | u64 | |
| output | usize | |
| to | u64 | |
| input | usize | |
Source: crates/platinum-sdk/src/node_editor.rs:14
platinum_sdk::node_editor::Canvas
pub struct Canvas
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| selected | Option<u64> | |
Source: crates/platinum-sdk/src/node_editor.rs:21
platinum_sdk::node_editor::Edit
pub enum Edit
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/node_editor.rs:29
platinum_sdk::node_editor::Canvas::show
pub fn show(
&mut self,
ui: &mut Ui,
salt: impl std::hash::Hash,
nodes: &[Node],
links: &[Link],
positions: &mut BTreeMap<u64, [f32; 2]>,
palette: &[&str],
height: f32,
) -> Vec<Edit>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/node_editor.rs:36
platinum_sdk::node_editor::Canvas::show_grid
pub fn show_grid(&mut self, ui: &mut Ui, salt: impl std::hash::Hash, nodes: &[Node])
Graph nodes in a stable, responsive grid, for collections with no topology.
The same Node/channel model is used by wired graphs and test result nodes.
Source: crates/platinum-sdk/src/node_editor.rs:420
platinum_sdk::panels
platinum_sdk::panels
Application-owned tool panels. Empty by default; content has no document dependency.
Source: crates/platinum-sdk/src/panels.rs:1
platinum_sdk::panels::DockSide
pub enum DockSide
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:14
platinum_sdk::panels::PanelPlacement
pub enum PanelPlacement
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:21
platinum_sdk::panels::PanelPreferences
pub struct PanelPreferences
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| enabled | bool | |
| pinned | bool | Keep this floating tool visible when the application loses focus.
Older workspace preferences restore to the unpinned behavior. |
| placement | PanelPlacement | |
| position | [i32; 2] | |
| size | [u32; 2] | |
Source: crates/platinum-sdk/src/panels.rs:26
platinum_sdk::panels::PanelWindow
pub struct PanelWindow
Marks native windows created for explicitly registered application panels.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| owner | Entity | |
Source: crates/platinum-sdk/src/panels.rs:38
platinum_sdk::panels::PanelActivation
pub struct PanelActivation
The embedding application selects the host and visibility policy each frame.
Public data fields| Name | Type / declaration | Description |
|---|
| owner | Option<Entity> | |
| visible | bool | Legacy document-context hint. Native tools follow actual application focus. |
| force_visible | bool | Allows screenshot fixtures to display application-owned panels without focus. |
Source: crates/platinum-sdk/src/panels.rs:44
platinum_sdk::panels::PanelSet
pub enum PanelSet
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:52
platinum_sdk::panels::PanelContext
pub struct PanelContext<'a>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| time | f64 | |
| id | &'a str | |
Source: crates/platinum-sdk/src/panels.rs:56
platinum_sdk::panels::PanelOutput
pub struct PanelOutput<A>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| actions | Vec<A> | |
| commands | Vec<CommandId> | |
Source: crates/platinum-sdk/src/panels.rs:60
platinum_sdk::panels::PanelOutput::actions
pub fn actions(actions: Vec<A>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:73
platinum_sdk::panels::PanelRenderer
pub type PanelRenderer<T, A>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:84
platinum_sdk::panels::PanelDefinition
pub struct PanelDefinition<T, A>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| id | String | |
| title | String | |
| initial | PanelPreferences | |
| dock_side | DockSide | |
| resizable | bool | |
| scroll | bool | |
| draw | PanelRenderer<T, A> | |
Source: crates/platinum-sdk/src/panels.rs:85
platinum_sdk::panels::PanelDefinition::new
pub fn new(id: impl Into<String>, title: impl Into<String>, draw: PanelRenderer<T, A>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:95
platinum_sdk::panels::Panel
pub struct Panel<T, A>
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| definition | PanelDefinition<T, A> | |
| preferences | PanelPreferences | |
Source: crates/platinum-sdk/src/panels.rs:113
platinum_sdk::panels::PanelRegistry
pub struct PanelRegistry<T: Send + Sync + 'static, A: Send + Sync + 'static>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:119
platinum_sdk::panels::PanelRegistry::register
pub fn register(&mut self, definition: PanelDefinition<T, A>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:134
platinum_sdk::panels::PanelRegistry::len
pub fn len(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:157
platinum_sdk::panels::PanelRegistry::is_empty
pub fn is_empty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:160
platinum_sdk::panels::PanelRegistry::contains
pub fn contains(&self,id:&str)->bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:163
platinum_sdk::panels::PanelRegistry::set_enabled
pub fn set_enabled(&mut self,id:&str,enabled:bool)->bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:164
platinum_sdk::panels::PanelRegistry::set_pinned
pub fn set_pinned(&mut self, id: &str, pinned: bool) -> bool
Pinning changes focus visibility, never edit authority or ownership.
Source: crates/platinum-sdk/src/panels.rs:168
platinum_sdk::panels::PanelRegistry::surface
pub fn surface(&self, id: &str) -> Option<SurfaceHandle>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:176
platinum_sdk::panels::PanelRegistry::owns_window
pub fn owns_window(&self, window: Entity) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:182
platinum_sdk::panels::PanelRegistry::preferences
pub fn preferences(&self) -> BTreeMap<String, PanelPreferences>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:187
platinum_sdk::panels::PanelRegistry::restore
pub fn restore(&mut self, saved: &BTreeMap<String, PanelPreferences>)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:193
platinum_sdk::panels::PanelRegistry::set_placement
pub fn set_placement(&mut self, id: &str, placement: PanelPlacement)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:206
platinum_sdk::panels::PanelRegistry::resource_advisor
pub fn resource_advisor(&mut self) -> &mut crate::window_resources::WindowResourceAdvisor
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:211
platinum_sdk::panels::PanelRegistry::set_resource_policy
pub fn set_resource_policy(
&mut self,
id: &str,
policy: crate::window_resources::WindowResourcePolicy,
) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:214
platinum_sdk::panels::PanelRegistry::profile_resources
pub fn profile_resources(&mut self, time: f64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:221
platinum_sdk::panels::PanelRegistry::show_resource_advice
pub fn show_resource_advice(&mut self, ctx: &egui::Context, time: f64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:224
platinum_sdk::panels::PanelRegistry::toggle
pub fn toggle(&mut self, id: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:249
platinum_sdk::panels::PanelRegistry::toggle_docked
pub fn toggle_docked(&mut self, id: &str)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:254
platinum_sdk::panels::PanelRegistry::show_docked
pub fn show_docked(
&mut self,
ctx: &egui::Context,
content: &mut T,
time: f64,
enabled: bool,
) -> PanelOutput<A>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:263
platinum_sdk::panels::PanelRegistry::show_floating
pub fn show_floating(
&mut self,
ctx: &egui::Context,
window: Entity,
host: &mut Window,
content: &mut T,
time: f64,
enabled: bool,
) -> PanelOutput<A>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:339
platinum_sdk::panels::PanelRegistry::show_canvas_floating
pub fn show_canvas_floating(
&mut self,
ctx: &egui::Context,
content: &mut T,
time: f64,
enabled: bool,
) -> PanelOutput<A>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:373
platinum_sdk::panels::DockablePanelsPlugin
pub struct DockablePanelsPlugin<T: Send + Sync + 'static, A: Send + Sync + 'static>(
PhantomData<fn() -> (T, A)>,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/panels.rs:475
platinum_sdk::security_settings
platinum_sdk::security_settings
Reusable Runtime security settings editor. The trusted host persists and
installs accepted policies; rendering a draft never silently changes policy.
Source: crates/platinum-sdk/src/security_settings.rs:1
platinum_sdk::security_settings::SecuritySettingsEditor
pub struct SecuritySettingsEditor
One editor per settings host. Call `show` only in its chosen document context.
Public data fields| Name | Type / declaration | Description |
|---|
| open | bool | |
Source: crates/platinum-sdk/src/security_settings.rs:7
platinum_sdk::security_settings::SecuritySettingsEditor::new
pub fn new(settings: &RuntimeSecuritySettings) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/security_settings.rs:15
platinum_sdk::security_settings::SecuritySettingsEditor::menu_item
pub fn menu_item(&mut self, ui: &mut egui::Ui, current: &RuntimeSecuritySettings)
Place in the host's Settings menu alongside its existing preferences.
Source: crates/platinum-sdk/src/security_settings.rs:24
platinum_sdk::security_settings::SecuritySettingsEditor::show
pub fn show(&mut self, ctx: &egui::Context) -> Option<RuntimeSecuritySettings>
Returns a validated Apply request. The host must authorize, persist and
install it before reporting success; this editor claims none of those steps.
Source: crates/platinum-sdk/src/security_settings.rs:34
platinum_sdk::security_settings::SecuritySettingsEditor::rejected
pub fn rejected(&mut self, message: impl Into<String>)
Keep the editor open and display the host's rejection, never imply success.
Source: crates/platinum-sdk/src/security_settings.rs:93
platinum_sdk::security_settings::SecuritySettingsEditor::accepted
pub fn accepted(&mut self)
Call only after the trusted host has persisted and installed the policy.
Source: crates/platinum-sdk/src/security_settings.rs:99
platinum_sdk::security_settings::SecuritySettingsAuthority
pub trait SecuritySettingsAuthority: Send + Sync + 'static
Trusted host adapter. These methods must return promptly: poll a cached result
and queue I/O to a worker, never block the GUI on disk or network requests.
The provider authorizes, durably installs and enforces policy before success.
Applications must not expose this resource or provider construction to Lua.
Source: crates/platinum-sdk/src/security_settings.rs:125
platinum_sdk::security_settings::SecuritySettingsHost
pub struct SecuritySettingsHost
Workspace integration is unavailable until a trusted host installs a provider.
There are deliberately no guessed defaults advertised as active system policy.
Source: crates/platinum-sdk/src/security_settings.rs:134
platinum_sdk::security_settings::SecuritySettingsHost::connected
pub fn connected(provider: Box<dyn SecuritySettingsAuthority>) -> Result<Self, String>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/security_settings.rs:141
platinum_sdk::security_settings::SecuritySettingsHost::available
pub fn available(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/security_settings.rs:153
platinum_sdk::security_settings::SecuritySettingsHost::menu_item
pub fn menu_item(&mut self, ui: &mut egui::Ui)
Call from an application menu. A missing Runtime settings service is
visible but cannot silently become a private application's global policy.
Source: crates/platinum-sdk/src/security_settings.rs:158
platinum_sdk::security_settings::SecuritySettingsHost::show
pub fn show(&mut self, ctx: &egui::Context)
Draw once in the focused document context and poll the nonblocking host.
Source: crates/platinum-sdk/src/security_settings.rs:167
platinum_sdk::workspace
platinum_sdk::workspace
Reusable native/web multi-document host for the Platinum editor components.
Source: crates/platinum-sdk/src/workspace.rs:1
platinum_sdk::workspace::DocumentPanels
pub type DocumentPanels
Empty by default. Applications register the tools they want for their documents.
Source: crates/platinum-sdk/src/workspace.rs:25
platinum_sdk::workspace::WorkspaceConfig
pub struct WorkspaceConfig
Configures the reusable document workspace without application-specific branding.
Public data fields| Name | Type / declaration | Description |
|---|
| state_tracking | bool | False selects the exact local path: no state worker or sync scheduler.
Desktop defaults managed; web defaults local until its provider is installed. |
| start_with_document | bool | Native applications can give the primary window to the file manager. |
| files_enabled | bool | |
| initial_folder | Option<std::path::PathBuf> | |
| restore_folders | bool | |
| files_state_path | Option<std::path::PathBuf> | |
| app_id | String | |
| title | String | |
| about | String | |
| recovery_enabled | bool | |
| initial_document | RichDocument | |
| initial_name | String | |
| menus | office::MenuHost | |
Source: crates/platinum-sdk/src/workspace.rs:29
platinum_sdk::workspace::WorkspaceConfig::new
pub fn new(app_id: impl Into<String>, title: impl Into<String>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:48
platinum_sdk::workspace::DocumentWorkspacePlugin
pub struct DocumentWorkspacePlugin(pub WorkspaceConfig)
Install into an app created with office::application. Owns document/dialog windows,
focus, clipboard, file results, saved-session recovery and standard command dispatch.
Source: crates/platinum-sdk/src/workspace.rs:77
platinum_sdk::workspace::WorkspaceStartup
pub struct WorkspaceStartup
Order application startup after this set when accessing Workspace.
Source: crates/platinum-sdk/src/workspace.rs:80
platinum_sdk::workspace::WorkspaceSet
pub enum WorkspaceSet
Integration points for application systems around the SDK workspace loop.
Source: crates/platinum-sdk/src/workspace.rs:83
platinum_sdk::workspace::DocumentSession
pub struct DocumentSession
Window binding for an independently reusable document editor.
Public data fields| Name | Type / declaration | Description |
|---|
| sync_close_requested | bool | |
| state_root | String | |
| path | Option<std::path::PathBuf> | |
| window | Entity | |
| camera | Entity | |
| content | editor::DocumentEditor | |
| pending_close | bool | |
Source: crates/platinum-sdk/src/workspace.rs:148
platinum_sdk::workspace::DocumentSession::new
pub fn new(window: Entity, camera: Entity, doc: RichDocument, name: String) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:163
platinum_sdk::workspace::DocumentSession::dirty
pub fn dirty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:179
platinum_sdk::workspace::DocumentSession::record
pub fn record(&mut self, before: RichDocument, time: f64, typing: bool)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:182
platinum_sdk::workspace::DialogSurface
pub struct DialogSurface
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| owner | Entity | |
| window | Entity | |
| camera | Entity | |
Source: crates/platinum-sdk/src/workspace.rs:188
platinum_sdk::workspace::DrawTiming
pub struct DrawTiming
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| samples | Vec<f64> | |
Source: crates/platinum-sdk/src/workspace.rs:197
platinum_sdk::workspace::Workspace
pub struct Workspace
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| session_notice | Option<String> | |
| state_tracking | bool | |
| keep_alive | bool | |
| docs | Vec<DocumentSession> | |
| active | Entity | |
| panel_preferences | BTreeMap<String, PanelPreferences> | |
| dialog | Option<DialogSurface> | |
| busy | Option<(Entity, bool)> | |
| timer | Timer | |
| last_draft | String | |
| recovery_blocked | bool | |
| inactive | f32 | |
| app_id | String | |
| about | String | |
| clip_actions | Vec<(Entity, Action)> | |
Source: crates/platinum-sdk/src/workspace.rs:214
platinum_sdk::workspace::Workspace::manifest_settled
pub fn manifest_settled(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:233
platinum_sdk::workspace::create_document
pub fn create_document(
commands: &mut Commands,
ws: &mut Workspace,
doc: RichDocument,
name: String,
)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/workspace.rs:261
platinum_sdk::live_data
platinum_sdk::live_data
Generic reflected data inspector shared by SDK object, asset and test editors.
Editing produces a draft; the owning service validates and commits it.
Source: crates/platinum-sdk/src/authoring/live_data.rs:1
platinum_sdk::live_data::LiveDataView
pub struct LiveDataView
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| search | String | |
| selected_channel | Option<String> | |
| has_invalid_edits | bool | |
Source: crates/platinum-sdk/src/authoring/live_data.rs:7
platinum_sdk::live_data::LiveDataView::show
pub fn show(
&mut self,
ui: &mut Ui,
salt: impl std::hash::Hash,
data: &mut Value,
editable: bool,
) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/authoring/live_data.rs:13
platinum_sdk::live_data::reflected_value
pub fn reflected_value(
value: &dyn bevy::reflect::PartialReflect,
registry: &bevy::reflect::TypeRegistry,
) -> Result<serde_json::Value, String>
Adapter for arbitrary Bevy-reflected data registered with serialization support.
Hosts retain type validation and authorization when applying an edited draft.
Source: crates/platinum-sdk/src/authoring/live_data.rs:150
platinum_sdk::thumbnail_cache
platinum_sdk::thumbnail_cache
Scoped asynchronous thumbnails over admitted immutable ContentViews.
Labels identify cache entries; only the trusted live access gate authorizes reads.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:1
platinum_sdk::thumbnail_cache::ThumbnailError
pub enum ThumbnailError
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:18
platinum_sdk::thumbnail_cache::ThumbnailReadPermit
pub trait ThumbnailReadPermit
Host-owned permit, normally wrapping a capability read guard. Its lifetime
must fence revocation until the permitted operation completes.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:43
platinum_sdk::thumbnail_cache::ThumbnailAccess
pub trait ThumbnailAccess: Send + Sync + 'static
Implemented by the trusted host, not by a remote UI or an opaque scope label.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:45
platinum_sdk::thumbnail_cache::ThumbnailScope
pub struct ThumbnailScope(u64)
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:52
platinum_sdk::thumbnail_cache::ThumbnailReference
pub enum ThumbnailReference
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:54
platinum_sdk::thumbnail_cache::ThumbnailRenderer
pub enum ThumbnailRenderer
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:59
platinum_sdk::thumbnail_cache::ThumbnailRecipe
pub struct ThumbnailRecipe
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| width | u32 | |
| height | u32 | |
| renderer | ThumbnailRenderer | |
Source: crates/platinum-sdk/src/thumbnail_cache.rs:69
platinum_sdk::thumbnail_cache::ThumbnailRecipe::image
pub fn image(width: u32, height: u32) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:75
platinum_sdk::thumbnail_cache::ThumbnailSource
pub struct ThumbnailSource(Arc<SourceInner>)
Already admitted provider plus a live trusted gate. Construction does not
turn an AssetId, path, scope, hash, or cached pixel into a permission.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:109
platinum_sdk::thumbnail_cache::ThumbnailSource::admitted
pub fn admitted(view: ContentView, access: Arc<dyn ThumbnailAccess>) -> Self
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:111
platinum_sdk::thumbnail_cache::ThumbnailSource::scope
pub fn scope(&self) -> ThumbnailScope
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:123
platinum_sdk::thumbnail_cache::ThumbnailSource::revoke
pub fn revoke(&self)
Completes after this source's in-progress disclosure callbacks finish.
Already copied/uploaded pixels cannot be recalled; consumers purge them.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:128
platinum_sdk::thumbnail_cache::ThumbnailSource::replace_view
pub fn replace_view(&self, view: ContentView) -> Result<(), ThumbnailError>
Publish a new admitted immutable index. The host gate must admit its view
identity too. Real AssetIds with unchanged provider hashes survive renames.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:135
platinum_sdk::thumbnail_cache::ThumbnailSource::invalidate
pub fn invalidate(&self, reference: &ThumbnailReference) -> Result<(), ThumbnailError>
Call after an SDK mutation, before a refreshed provider index is exposed.
This item remains stale until a different immutable view is published.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:150
platinum_sdk::thumbnail_cache::ThumbnailSource::on_renamed
pub fn on_renamed(&self, old: &ThumbnailReference) -> Result<(), ThumbnailError>
Rename keeps an actual AssetId; callers without one invalidate the old
path then publish the new index. No OS-global GUID is fabricated.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:174
platinum_sdk::thumbnail_cache::ThumbnailSource::on_removed
pub fn on_removed(&self, item: &ThumbnailReference) -> Result<(), ThumbnailError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:180
platinum_sdk::thumbnail_cache::ThumbnailSource::on_changed
pub fn on_changed(&self, item: &ThumbnailReference) -> Result<(), ThumbnailError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:183
platinum_sdk::thumbnail_cache::ThumbnailLimits
pub struct ThumbnailLimits
Description not yet supplied in source. Signature and location are extracted evidence.
Public data fields| Name | Type / declaration | Description |
|---|
| entries | usize | |
| cached_bytes | usize | |
| queue_depth | usize | |
| source_bytes | u64 | |
| source_dimension | u32 | |
| source_pixels | u64 | |
| owned_decode_bytes | u64 | |
| thumbnail_dimension | u32 | |
| thumbnail_pixels | u64 | |
Source: crates/platinum-sdk/src/thumbnail_cache.rs:258
platinum_sdk::thumbnail_cache::ThumbnailLease
pub struct ThumbnailLease
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:349
platinum_sdk::thumbnail_cache::ThumbnailLease::with_rgba
pub fn with_rgba<T>(
&self,
action: impl FnOnce(u32, u32, &[u8]) -> T,
) -> Result<T, ThumbnailError>
Rechecks live authority and revision for every disclosure/use. The host
permit and local revocation guard stay held through this callback.
Do not reenter source mutation/revocation from the callback.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:358
platinum_sdk::thumbnail_cache::ExternalThumbnailTicket
pub struct ExternalThumbnailTicket
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:376
platinum_sdk::thumbnail_cache::ExternalThumbnailTicket::reference
pub fn reference(&self) -> &ThumbnailReference
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:382
platinum_sdk::thumbnail_cache::ExternalThumbnailTicket::recipe
pub fn recipe(&self) -> &ThumbnailRecipe
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:385
platinum_sdk::thumbnail_cache::ThumbnailStatus
pub enum ThumbnailStatus
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:389
platinum_sdk::thumbnail_cache::ThumbnailExecution
pub enum ThumbnailExecution
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:396
platinum_sdk::thumbnail_cache::ThumbnailCache
pub struct ThumbnailCache
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:432
platinum_sdk::thumbnail_cache::ThumbnailCache::new
pub fn new(
limits: ThumbnailLimits,
execution: ThumbnailExecution,
) -> Result<Self, ThumbnailError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:440
platinum_sdk::thumbnail_cache::ThumbnailCache::request
pub fn request(
&mut self,
source: &ThumbnailSource,
reference: &ThumbnailReference,
recipe: &ThumbnailRecipe,
) -> Result<ThumbnailStatus, ThumbnailError>
Expected O(1) indexed lookup. Never reads/decodes image content on this path.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:471
platinum_sdk::thumbnail_cache::ThumbnailCache::pump_cooperative
pub fn pump_cooperative(&mut self, maximum_jobs: usize) -> Result<usize, ThumbnailError>
Explicitly run outside paint. On WASM this performs synchronous bounded
decode jobs cooperatively; it is NOT a Web Worker or a time-sliced decoder.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:532
platinum_sdk::thumbnail_cache::ThumbnailCache::poll
pub fn poll(&mut self, maximum_results: usize) -> usize
Accept at most N completed results; stale/revoked/source-revision results
are discarded before they can become Ready or be disclosed.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:549
platinum_sdk::thumbnail_cache::ThumbnailCache::submit_external
pub fn submit_external(
&mut self,
ticket: ExternalThumbnailTicket,
width: u32,
height: u32,
rgba: Vec<u8>,
) -> Result<(), ThumbnailError>
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:565
platinum_sdk::thumbnail_cache::ThumbnailCache::maintain
pub fn maintain(&mut self, maximum_entries: usize) -> usize
Incrementally checks immutable index membership, revisions, mutation
generations and source liveness. No tree scan, disk stat or content read.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:612
platinum_sdk::thumbnail_cache::ThumbnailCache::cached_bytes
pub fn cached_bytes(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:635
platinum_sdk::thumbnail_cache::ThumbnailCache::len
pub fn len(&self) -> usize
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:638
platinum_sdk::thumbnail_cache::ThumbnailCache::is_empty
pub fn is_empty(&self) -> bool
Description not yet supplied in source. Signature and location are extracted evidence.
Source: crates/platinum-sdk/src/thumbnail_cache.rs:641