eo-typewriterjs / TAudioCommandOverride
Type Alias: TAudioCommandOverride
ts
type TAudioCommandOverride =
| false
| {
sfx?: string;
sfxs?: readonly string[];
volume?: number;
};Defined in: core/audio/types/audio-command-override.type.ts:7
Union Members
false
Type Literal
ts
{
sfx?: string;
sfxs?: readonly string[];
volume?: number;
}| Name | Type | Description | Defined in |
|---|---|---|---|
sfx? | string | Description Name of a single sfx from the sfx pack to use for this command. Takes priority over the channel default. | core/audio/types/audio-command-override.type.ts:15 |
sfxs? | readonly string[] | Description Subset of sfx names to select from for this command. When provided, the audio manager picks from only these sfxs. Takes priority over sfx when both are set. | core/audio/types/audio-command-override.type.ts:23 |
volume? | number | Description Per-command volume override in the range [0, 1]. Multiplied against the master volume. | core/audio/types/audio-command-override.type.ts:30 |
Description
Per-command audio override. Set to false to silence audio for this specific command. Set to an object to use a specific sfx or volume for this command.