Naev

Module spfx

Lua bindings to interact with the Special effects.

An example would be:

 spfx.soundPlay( "hail" ) -- Plays the hail sound
 

Functions

soundPlay (s[, pos[, vel]]) Plays a sound.


Functions

soundPlay (s[, pos[, vel]])
Plays a sound.

by default, the sound is played at player's current position ( s )

Parameters:

  • s string Name of the sound to play
  • pos Vec2 Position of the source (optional)
  • vel Vec2 Velocity of the source (optional)

Usage:

  • spfx.soundPlay( "hail" ) -- Plays the hail sound
  • spfx.soundPlay( "hail", pos ) -- Plays the hail sound at position pos
  • spfx.soundPlay( "hail", pos, vel ) -- Plays the hail sound at position pos with velocity vel
generated by LDoc 1.4.6 Last updated 2020-10-01 02:30:07