AmbientSoundEffect

Methods
4
Fields
None

Methods

MethodReturnsDescription
getSoundEffectId()numberThe sound effect's id (SoundEffectID), -1 for none.
getBackgroundSoundEffectIds(){number}?The background sound effect ids, one of which plays at random now and then, or nil when it has none. Read from the client while it still ho…
getPlane()numberThe plane it is on.
equals(any)booleanWhether other equals this AmbientSoundEffect, as == answers it (false for a value of another class).

Returned by

MethodReturnsDescription
AmbientSoundEffectCreated.getAmbientSoundEffectAmbientSoundEffectThe sound just made: the last of its world view's ambient sounds now (for the top level, the last of client:getAmbientSoundEffects(), and…

Method details

getBackgroundSoundEffectIds

getBackgroundSoundEffectIds: (AmbientSoundEffect) -> {number}?

The background sound effect ids, one of which plays at random now and then, or nil when it has none. Read from the client while it still holds the sound (in the list, or fading out after a clear()), in whichever world view holds it (a boat's included); nil once the client has dropped it or made another sound at its address.

equals

equals: (AmbientSoundEffect, any) -> boolean

Whether other equals this AmbientSoundEffect, as == answers it (false for a value of another class).