`pyxen.Sound`

A short audio clip attached to an Entity as a component.

Sounds are loaded entirely into memory — use them for short effects like jumps, hits, and pickups.

For audio concepts, see Audio.

Constructor

Sound(filename)

One required positional argument: the name of a WAV audio asset in the project.

Parameter	Type	Description
`filename`	`str`	Name of the WAV asset

jump_sound = Sound("jump")

During spawn:

sfx = world.spawn(sound=Sound("jump"))

Or later:

entity.sound = Sound("jump")

Assigning a sound starts playback immediately.

Access via entity.sound:

Property	Type	R/W	Description
`loop`	`bool`	R/W	Enable looping
`volume`	`float`	R/W	Gain (clamped >= 0.0)
`pan`	`float`	R/W	Stereo panning (-1.0 to 1.0)
`time`	`float`	R	Current playback position (seconds)
`duration`	`float`	R	Total length (seconds)
`finished`	`bool`	R	True when playback has completed

entity.sound.loop = True

When enabled, the sound restarts automatically after finishing.

entity.sound.volume = 0.5

Values below 0.0 are clamped to 0.0.

entity.sound.pan = -1.0  # full left
entity.sound.pan =  1.0  # full right
entity.sound.pan =  0.0  # center

Clamped to the range -1.0 to 1.0.

t = entity.sound.time

Read-only. Current playback position in seconds.

d = entity.sound.duration

Read-only. Total length of the sound in seconds.

if entity.sound.finished:
    world.destroy(entity)

Read-only. True when the sound has finished playing (and loop is False).

Sound assets must be WAV files.

Sound()

ValueError: Sound must have a file

Sound("nonexistent")

The sound object is created but playback will fail silently with a warning logged.