getSoundId
getSoundId: (AreaSoundEffectPlayed) -> numberThe sound.
| Field | Type | Description |
|---|---|---|
__eventClass | string | "AreaSoundEffectPlayed": the class's name, which host APIs that take the class itself read. |
getSoundIdgetSoundId: (AreaSoundEffectPlayed) -> numberThe sound.
getSceneXgetSceneX: (AreaSoundEffectPlayed) -> numberThe scene tile's x (-1 on a legacy copy, which carried a world tile).
getSceneYgetSceneY: (AreaSoundEffectPlayed) -> numberThe scene tile's y.
getRangegetRange: (AreaSoundEffectPlayed) -> numberHow far it is heard, tiles.
getDelaygetDelay: (AreaSoundEffectPlayed) -> numberIts delay, client cycles.
consumeconsume: (AreaSoundEffectPlayed) -> ()Do not play it.