Sound

This entity can be placed in a level to play back sounds.

It also has a constructor so that it can be created thorugh code. If created this way, the entity will yeet itself once it finishes playing back the sound. This way you can play a sound effect and then forget it.

Fields

Flags | Int32

Bitmask, see flags section.

Sound | Name

Name of the sound that the entity will play back.

Volume | Float32

How loud the sound will be. From 0.0 to 1.0.

Flags

1 | SOUND_LOOPING

The sound will loop after finishing.

2 | SOUND_START_ON_LOAD

The sound will begin playback as soon as the entity is loaded. Useful for ambient sort of environmental sounds

Messages

Toggle | TOGGLE

If the sound is being played, it will be stopped. If it is stopped, it will start again.

Kill | KILL

This yeets the entity.

Start | START

Starts playing back the sound.

Stop | STOP

Stops playing back the sound.

Signals

There are none.