Sound¶

Class for playing in-game 2D and 3D sounds.

Note

This is a Client only Class.

Note

It is not possible (yet?) to load custom sound files (.mp3, .wav…), the sounds must be pre-cooked in Unreal before used.

Usage¶

local MySound = Sound(
    Vector(-510, 145, 63), -- Location (if a 3D sound)
    "NanosWorld::A_VR_Confirm", -- Asset Path
    false, -- Is 2D Sound
    true, -- Auto Destroy (if to destroy after finished playing)
    0, -- Sound Type (SFX)
    1, -- Volume
    1 -- Pitch
)

Constructor Parameters¶

Type	Name	Default
Vector	Location (Used only if 3D sound)	Vector(0, 0, 0)
string	Asset (Sound)
boolean	Is2DSound	false
boolean	AutoDestroy (if to destroy after finished playing)	true
number	Sound Type (0 - SFX, 1 - Music) - Used to apply user’s volume settings	0
number	Volume (0 - 1)	1
number	Pitch	1
number	InnerRadius (3D only)	400
number	FalloffDistance (3D only)	3600
number	AttenuationFunction (3D only) (0 - Linear, 1 - Logarithmic, 2 - Inverse, 3 - Log Reverse, 4 - Natural Sound)	0
boolean	KeepPlayingWhenSilent (3D only) - Whether to keep playing this sound when it’s not audible - Use with caution, it may cause performance issues!	false

Functions¶

Returns	Name	Description
	FadeIn(number FadeInDuration, number FadeVolumeLevel, number StartTime)	Plays the sound with a fade effect
	FadeOut(number FadeOutDuration, number FadeVolumeLevel)	Stops the sound with a fade effect
	Play(number StartTime = 0)	Starts the sound
	SetFalloffDistance(number FalloffDistance)	If a 3D Sound, sets the distance which the sound is inaudible
	SetInnerRadius(number InnerRadius)	If a 3D Sound, sets the distance within the volume is 100%
	SetLowPassFilter(number Frequency)	Sets lowpass filter frequency. Sets 0 to disable it.
	SetPaused(boolean Pause = true)	Pauses the sound
	SetPitch(number NewPitch)	Sets the Sound’s pitch
	SetVolume(number NewVolume)	Sets the Sound’s volume (0 - 1)
	Stop()	Stops the sound
	StopDelayed(number Delay)	Stops the sound after the provided delay
boolean	IsPlaying()	Returns if the sound is playing

Functions (Inherited from Actor)¶

Returns	Name	Description
	AddImpulse(Vector Force)	Applies a Force in world coordinate on this Actor (the force is applied on Client side, by the (in most of cases) the closest player of this object)
	AttachTo(Actor Other, string BoneName, Vector RelativeLocation, Rotator RelativeRotation)	Attaches this Actor to any other Actor with a Relative Offset/Rotation
	Destroy()	Destroys this Actor
	SetCollision(number CollisionType)	Sets the actor’s collision (0 - Normal, 1 - Static Only, 2 - No Collision)
	SetGravityEnabled(boolean NewGravity)	Sets the actor’s gravity enabled
	SetHighlightEnabled(boolean Enabled)	Sets if this Actors is Highlighting
	SetInitialLocation(Vector NewInitialLocation)	Sets the initial location
	SetLocation(Vector NewLocation)	Sets the actor’s location in the game world
	SetRotation(Rotator NewRotation)	Sets the actor’s rotation in the game world
	SetScale(Vector Scale)	Sets the actor’s scale
	SetTintColor(Color NewTintColor)	Sets the tint color, for completely paint an object, multiply the color by 10 or 100
	SetValue(string Key, any Value)	Sets a value in this entity, which can be accessed by any package (local only)
boolean	IsGravityEnabled()	Gets the actor’s gravity enabled
boolean	IsValid()	Returns if this is Valid
number	GetCollision()	Gets the current actor’s collision
number	GetID()	Gets the network ID of this entity (same in both client and server)
Vector	GetLocation()	Get the actor’s position in the game world
Vector	GetInitialLocation()	Gets the initial location
Rotator	GetRotation()	Gets the actor’s rotation in the game world
Vector	GetScale()	Gets the actor’s scale
Color	GetTintColor()	Gets the Tint Color
string	GetType()	Returns the type of this Actor
any	GetValue(string Key)	Gets a value given a key

Events¶

Events (Inherited from Actor)¶

Name	Arguments	Description
Destroy	Entity actor	Triggered when an Entity is Destroyed
Spawn	Entity actor	Triggered when an Entity is Spawned/Created