🔊 Sound
Class for playing in-game 2D and 3D sounds.
💂Authority
This class can only be spawned on 🟧 Client side.
👪Inheritance
This class shares methods and events from Base Entity, Base Actor.
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
tip
You can also load raw .ogg
files from disk! Please check SpecialPath.
🎒 Examples
local my_sound = Sound(
Vector(-510, 145, 63), -- Location (if a 3D sound)
"nanos-world::A_VR_Confirm", -- Asset Path
false, -- Is 2D Sound
true, -- Auto Destroy (if to destroy after finished playing)
SoundType.SFX,
1, -- Volume
1 -- Pitch
)
-- Spawning a ogg sound located in a Package
local ogg_sound = Sound(Vector(), "package://my-package/Client/awesome_beep.ogg", true)
🛠 Constructors
Normal
local my_sound = Sound(location, asset, is_2D_sound?, auto_destroy?, sound_type?, volume?, pitch?, inner_radius?, falloff_distance?, attenuation_function?, keep_playig_when_silent?, loop_mode?)
Type | Name | Default | Description |
---|---|---|---|
Vector | location | Required parameter | Only used if 3D sound |
Sound Reference | asset | Required parameter | The Sound Asset to load |
boolean | is_2D_sound | false | Whether to spawn it as 2D or 3D |
boolean | auto_destroy | true | Whether to destroy after finished playing |
SoundType | sound_type | SoundType.SFX | Used to apply user's volume settings |
float | volume | 1 | No description provided |
float | pitch | 1 | No description provided |
float | inner_radius | 400 | Only used if 3D sound |
float | falloff_distance | 3600 | Only used if 3D sound |
AttenuationFunction | attenuation_function | Linear | Only used if 3D sound |
boolean | keep_playig_when_silent | false | Only used if 3D sound - Use with caution, it may cause performance issues! |
SoundLoopMode | loop_mode | Default | Whether should force sound to loop |
Note
auto_destroy
means the Entity will be immediately destroyed after spawned, losing references to the Particle System spawned in-game. So if the Particle System itself loops indefinitely, it will keep playing until the Player reconnects.
🗿 Static Functions
Inherited Entity Static Functions
Sound inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity
Base Entityscripting-reference/classes/base-classes/Entity
Returns | Name | Description | |
---|---|---|---|
table of Base Entity | GetAll | Returns a table containing all Entities of the class this is called on | |
Base Entity | GetByIndex | Returns a specific Entity of this class at an index | |
integer | GetCount | Returns how many Entities of this class exist | |
table of table | GetInheritedClasses | Gets a list of all directly inherited classes from this Class created with the Inheriting System | |
iterator | GetPairs | Returns an iterator with all Entities of this class to be used with pairs() | |
table or nil | GetParentClass | Gets the parent class if this Class was created with the Inheriting System | |
table | Inherit | Inherits this class with the Inheriting System | |
boolean | IsChildOf | Gets if this Class is child of another class if this Class was created with the Inheriting System | |
function | Subscribe | Subscribes to an Event for all entities of this Class | |
function | SubscribeRemote | Subscribes to a custom event called from server | |
Unsubscribe | Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed |
🦠 Functions
Inherited Entity Functions
Sound inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity
Base Entityscripting-reference/classes/base-classes/Entity
Returns | Name | Description | |
---|---|---|---|
BroadcastRemoteEvent | Calls a custom remote event directly on this entity to all Players | ||
CallRemoteEvent | Calls a custom remote event directly on this entity to a specific Player | ||
CallRemoteEvent | Calls a custom remote event directly on this entity | ||
Destroy | Destroys this Entity | ||
table of string | GetAllValuesKeys | Gets a list of all values keys | |
table | GetClass | Gets the class of this entity | |
integer | GetID | Gets the universal network ID of this Entity (same on both client and server) | |
any | GetValue | Gets a Value stored on this Entity at the given key | |
boolean | IsA | Recursively checks if this entity is inherited from a Class | |
boolean | IsValid | Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity) | |
SetValue | Sets a Value in this Entity | ||
function | Subscribe | Subscribes to an Event on this specific entity | |
function | SubscribeRemote | Subscribes to a custom event called from server on this specific entity | |
Unsubscribe | Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed |
Inherited Actor Functions
Sound inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/Actor
Base Actorscripting-reference/classes/base-classes/Actor
Returns | Name | Description | |
---|---|---|---|
AddActorTag | Adds an Unreal Actor Tag to this Actor | ||
AddImpulse | Applies a force in world world to this Actor | ||
AttachTo | Attaches this Actor to any other Actor, optionally at a specific bone | ||
Detach | Detaches this Actor from AttachedTo Actor | ||
table of string | GetActorTags | Gets all Unreal Actor Tags on this Actor | |
table of Base Actor | GetAttachedEntities | Gets all Actors attached to this Actor | |
Base Actor or nil | GetAttachedTo | Gets the Actor this Actor is attached to | |
table | GetBounds | Gets this Actor's bounds | |
CollisionType | GetCollision | Gets this Actor's collision type | |
integer | GetDimension | Gets this Actor's dimension | |
float | GetDistanceFromCamera | Gets the distance of this Actor from the Camera | |
Vector | GetForce | Gets this Actor's force (set by SetForce() ) | |
Vector | GetLocation | Gets this Actor's location in the game world | |
Player or nil | GetNetworkAuthority | Gets this Actor's Network Authority Player | |
Vector | GetRelativeLocation | Gets this Actor's Relative Location if it's attached | |
Rotator | GetRelativeRotation | Gets this Actor's Relative Rotation if it's attached | |
Rotator | GetRotation | Gets this Actor's angle in the game world | |
Vector | GetScale | Gets this Actor's scale | |
float | GetScreenPercentage | Gets the percentage of this Actor size in the screen | |
Vector | GetVelocity | Gets this Actor's current velocity | |
boolean | HasAuthority | Gets if this Actor was spawned by the client side | |
boolean | HasNetworkAuthority | Returns true if the local Player is currently the Network Authority of this Actor | |
boolean | IsBeingDestroyed | Returns true if this Actor is being destroyed | |
boolean | IsGravityEnabled | Returns true if gravity is enabled on this Actor | |
boolean | IsInWater | Returns true if this Actor is in water | |
boolean | IsNetworkDistributed | Returns true if this Actor is currently network distributed | |
boolean | IsVisible | Returns true if this Actor is visible | |
RemoveActorTag | Removes an Unreal Actor Tag from this Actor | ||
RotateTo | Smoothly rotates this actor to an angle over a certain time | ||
SetCollision | Sets this Actor's collision type | ||
SetDimension | Sets this Actor's Dimension | ||
SetForce | Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel | ||
SetGravityEnabled | Sets whether gravity is enabled on this Actor | ||
SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight index to use | ||
SetLifeSpan | Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed. | ||
SetLocation | Sets this Actor's location in the game world | ||
SetNetworkAuthority | Sets the Player to have network authority over this Actor | ||
SetNetworkAuthorityAutoDistributed | Sets if this Actor will auto distribute the network authority between players | ||
SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | ||
SetRelativeLocation | Sets this Actor's relative location in local space (only if this actor is attached) | ||
SetRelativeRotation | Sets this Actor's relative rotation in local space (only if this actor is attached) | ||
SetRotation | Sets this Actor's rotation in the game world | ||
SetScale | Sets this Actor's scale | ||
SetVisibility | Sets whether the actor is visible or not | ||
TranslateTo | Smoothly moves this actor to a location over a certain time | ||
boolean | WasRecentlyRendered | Gets if this Actor was recently rendered on screen |
Returns | Name | Description | |
---|---|---|---|
FadeIn | Plays the sound with a fade effect | ||
FadeOut | Stops the sound with a fade effect | ||
float | GetDuration | Gets the duration of the Sound | |
float | GetFalloffDistance | No description provided | |
float | GetInnerRadius | No description provided | |
float | GetLowPassFilter | No description provided | |
string | GetPath | No description provided | |
float | GetPitch | No description provided | |
float | GetSoundType | No description provided | |
float | GetVolume | No description provided | |
boolean | Is2D | Gets if the sound is 2D | |
boolean | IsPlaying | Gets if the sound is playing | |
Play | Starts the sound | ||
SetFalloffDistance | If a 3D Sound, sets the distance which the sound is inaudible | ||
SetInnerRadius | If a 3D Sound, sets the distance within the volume is 100% | ||
SetLowPassFilter | Sets lowpass filter frequency. Sets 0 to disable it. | ||
SetPaused | Pauses the sound | ||
SetPitch | Sets the Sound's pitch | ||
SetVolume | Sets the Sound's volume | ||
Stop | Stops the sound | ||
StopDelayed | Stops the sound after the provided delay |
FadeIn
Plays the sound with a fade effect
my_sound:FadeIn(fade_in_duration, fade_volume_level?, start_time?)
Type | Parameter | Default | Description |
---|---|---|---|
float | fade_in_duration | Required parameter | No description provided |
float | fade_volume_level? | 1 | No description provided |
float | start_time? | 0 | No description provided |
FadeOut
Stops the sound with a fade effect
my_sound:FadeOut(fade_out_duration, fade_volume_level?, destroy_after_fadeout?)
Type | Parameter | Default | Description |
---|---|---|---|
float | fade_out_duration | Required parameter | No description provided |
float | fade_volume_level? | 0 | No description provided |
boolean | destroy_after_fadeout? | false | No description provided |
GetDuration
Gets the duration of the Sound
— Returns float.
local ret = my_sound:GetDuration()
GetFalloffDistance
— Returns float.
local ret = my_sound:GetFalloffDistance()
See also SetFalloffDistance.
GetInnerRadius
— Returns float.
local ret = my_sound:GetInnerRadius()
See also SetInnerRadius.
GetLowPassFilter
— Returns float.
local ret = my_sound:GetLowPassFilter()
See also SetLowPassFilter.
GetPath
— Returns string.
local ret = my_sound:GetPath()
GetPitch
— Returns float.
local ret = my_sound:GetPitch()
See also SetPitch.