concinnity-core 0.19.24

Runtime vocabulary for the Concinnity engine: GPU layouts, ECS components, registry, CPU kernels
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// src/components/play_cue.rs

use crate::components::CueKind;
use crate::ecs::AudioClipHandle;

/// Runtime-only event asking the audio system to play a clip: the direct
/// equivalent of an AudioCue firing, for systems that trigger audio from their
/// own state (the story system plays page music and one-shots this way). World
/// authors never declare this type directly.
#[derive(Debug, Clone, Copy)]
pub struct PlayCue {
    /// The clip to play.
    pub clip: AudioClipHandle,
    /// Whether the clip plays as a one-shot or a loop.
    pub kind: CueKind,
    /// Linear gain applied on top of the bus volume.
    pub volume: f32,
    /// Voice priority for a one-shot request (higher wins a full voice pool).
    pub priority: i32,
}