speaker.hpp File Reference

Audio component. More...

#include <wizard_engine/assets.hpp>
#include <wizard_engine/component.hpp>
#include <wizard_engine/export.hpp>

Go to the source code of this file.

Classes
class	wze::speaker

Namespaces
namespace	wze
	Wizard Engine.

Detailed Description

Audio component.

Aligns the panning of the speaker relative to the camera.

Stops the sound of the speaker.

Resumes the sound of the speaker.

Pauses the sound of the speaker.

Plays the sound of the speaker.

Move assignment operator.

Copy assignment operator.

Destroys the speaker instance and erases from instances.

Move constructor.

Copy constructor.

Constructs a speaker instance and pushes into instances.

Returns whether the speaker is paused or not.

Returns whether the speaker is playing or not.

Sets whether the y position is affected by the angle.

Returns whether the y position is affected by the angle.

Sets whether the x position is affected by the angle.

Returns whether the x position is affected by the angle.

Sets whether the y position is attached to entities.

Returns whether the y position is attached to entities.

Sets whether the x position is attached to entities.

Returns whether the x position is attached to entities.

Sets the y offset of the speaker.

Returns the y offset of the speaker.

Sets the x offset of the speaker.

Returns the x offset of the speaker.

Sets whether the speaker is spatial or not.

Returns whether the speaker is spatial or not.

Sets the z position of the speaker.

Returns the z position of the speaker.

Sets the y position of the speaker.

Returns the y position of the speaker.

Sets the x position of the speaker.

Returns the x position of the speaker.

Sets whether the panning should be aligned automatically.

Returns whether the panning should be aligned automatically.

Sets the range of the speaker.

Returns the range of the speaker.

Sets the volume of the speaker.

Returns the volume of the speaker.

Sets the sound of the speaker.

Returns the sound of the speaker.

Unimplemented inherited method.

Author

Zana Domán

Zana Domán

Returns

Sound of the speaker.

Author

Zana Domán

Parameters

sound

Sound of the speaker.

Author

Zana Domán

Returns

Volume of the speaker.

Author

Zana Domán

Parameters

volume

Volume of the speaker.

Author

Zana Domán

Returns

Range of the speaker.

Author

Zana Domán

Parameters

range

Range of the speaker.

Author

Zana Domán

Returns

Whether the panning should be aligned automatically.

Author

Zana Domán

Parameters

auto_panning

Whether the panning should be aligned automatically.

Author

Zana Domán

Returns

X position of the speaker.

Author

Zana Domán

Parameters

x	X position of the speaker.

Author

Zana Domán

Returns

Y position of the speaker.

Author

Zana Domán

Parameters

y	Y position of the speaker.

Author

Zana Domán

Returns

Z position of the speaker.

Author

Zana Domán

Parameters

z	Z position of the speaker.

Author

Zana Domán

Returns

Whether the speaker is spatial or not.

Author

Zana Domán

Parameters

spatial

Whether the speaker is spatial or not.

Author

Zana Domán

Returns

X offset of the speaker.

Author

Zana Domán

Parameters

x_offset

X offset of the speaker.

Author

Zana Domán

Returns

Y offset of the speaker.

Author

Zana Domán

Parameters

y_offset

Y offset of the speaker.

Author

Zana Domán

Returns

Whether the x position is attached to entities.

Author

Zana Domán

Parameters

attach_x

Whether the x position is attached to entities.

Author

Zana Domán

Returns

Whether the y position is attached to entities.

Author

Zana Domán

Parameters

attach_y

Whether the y position is attached to entities.

Author

Zana Domán

Returns

Whether the x position is affected by the angle.

Author

Zana Domán

Parameters

x_angle_lock

Whether the x position is affected by the angle.

Author

Zana Domán

Returns

Whether the y position is affected by the angle.

Author

Zana Domán

Parameters

y_angle_lock

Whether the y position is affected by the angle.

Author

Zana Domán

Returns

Whether the speaker is playing or not.

Author

Zana Domán

Returns

Whether the speaker is paused or not.

Author

Zana Domán

Parameters

sound	Sound of the speaker.
volume	Volume of the speaker.
range	Range of the speaker.
auto_panning	Whether the panning should be aligned automatically.
x	X position of the speaker.
y	Y position of the speaker.
z	Z position of the speaker.
spatial	Whether the speaker is spatial or not.
x_offset	X offset of the speaker.
y_offset	Y offset of the speaker.
attach_x	Whether the x position is attached to entities.
attach_y	Whether the y position is attached to entities.
x_angle_lock	Whether the x position is affected by the angle.
y_angle_lock	Whether the y position is affected by the angle.

Author

Zana Domán

Parameters

other

Other speaker instance.

Author

Zana Domán

Parameters

other

Other speaker instance.

Returns

Self reference.

Author

Zana Domán

Parameters

fade_in	Fade in in milliseconds.
loops	Number of loops.

Warning

If the sound cannot be played, throws wze::exception.

Author

Zana Domán

Parameters

fade_out

Fade out in milliseconds.

Author

Zana Domán

Warning

If the panning cannot aligned, throws wze::exception.

Definition in file speaker.hpp.