Script API - v26.40.29
    Preparing search index...

    Class SoundDefinitionBeta

    Static metadata about a sound declared in a sound_definitions.json file.

    export class SoundDefinition {
        private constructor();
        readonly durationInfo?: SoundDefinitionDurationInfo;
        readonly musicInfo?: SoundDefinitionMusicInfo;
        readonly soundEventId: string;
        readonly tags?: Record<string, string[]>;
    }
    Index

    Constructors

    constructor

    Properties

    durationInfo? musicInfo? soundEventId tags?

    Constructors

    Properties

    Duration metadata declared for this sound. Undefined when the sound definition does not specify a duration.

    This property can't be read in early-execution mode.

    Music metadata declared for this sound. Undefined when the sound definition does not specify a music_info block.

    This property can't be read in early-execution mode.

    soundEventId: string

    Identifier of the sound event this definition declares, in the form 'namespace:name'.

    This property can't be read in early-execution mode.

    tags?: Record<string, string[]>

    Tag metadata declared for this sound, as a record mapping each tag name to its declared values. A tag declared with a single string value is exposed as a single-element array. Undefined when the sound definition does not specify any tags.

    This property can't be read in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties