Enum TelemetryEventKind 

#[repr(u32)]
pub enum TelemetryEventKind {
    FrameStart = 1,
    FrameEnd = 2,
    Paused = 3,
    Started = 4,
    Configuration = 5,
    Gameplay = 6,
}

Application-facing name for the canonical sdk::Event descriptor.

This is a re-export rather than a framework-owned mirror enum. Event identifiers and their minimum Telemetry API versions belong to the typed SDK layer; the plugin framework only records explicit subscriptions and turns the corresponding callbacks into TelemetryEvent payloads. Telemetry event which may be registered with the SCS SDK.

This type is the single typed representation of an SDK event identifier. Higher framework layers may re-export it under an application-facing name, but must not mirror its variants in a second enum: doing so would create a second event catalog which could drift when SCS adds another event.

Variants

FrameStart = 1

FrameEnd = 2

Paused = 3

Started = 4

Configuration = 5

Gameplay = 6

Implementations

impl Event

pub const fn raw(self) -> u32

Raw event discriminator passed to SCS registration functions and back to the registered callback.

pub const fn minimum_api_version(self) -> TelemetryApiVersion

Oldest Telemetry API which defines this event identifier.

SCS SDK 1.14 documents gameplay events as an API 1.01 addition. The other identifiers belong to the original API 1.00 event set. Keeping this capability metadata beside the canonical event enum ensures that registration policy and the raw numeric identifier cannot acquire separate, independently maintained event inventories.

pub const fn availability(self) -> GameSchemaAvailability

Oldest per-game schema which can emit this SDK event kind.

Gameplay callbacks require both Telemetry API 1.01 and the game schema which introduced gameplay events. Keeping those checks separate avoids comparing unrelated version domains. All original lifecycle and configuration event kinds exist from the first published game schemas.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Event

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Event

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Event