

SFX

Sound effects are played with the Stage's PlaySfx action.

1	{ "action": "CallMethod", "target":"stage", "method": "PlaySfx", "params": { "sfxType": "ShootForce", "pos":"vec2(0f, 10f)" }},

Some modifier parameters can be specified:

{ "action": "CallMethod", "target":"stage", "method": "PlaySfx", 
    "params": { 
        "sfxType": "ShootForce", 
        "pos":"playerPos + vec2(0f, 10f)",
        "volumeModifier": 0.75,
        "pitchModifier": 1.2,
        "maxDistanceModifier": 0.5 // this sound will half 50% of the max distance (if the sound is farther away than max distance from the player, it will not be played)
    }
},

If the pos parameter is not specified, sounds will play at the player's position.

Built-in SFX

This is a list of every built-in sound effect in the game, which you can use for bullet patterns or to trigger with PlaySfx.

SFX

"PlayerShoot",
"PlayerDie1",
"PlayerDie2",
"ShipShoot",

"PlayerHitPixel",
"BulletHitPlayerDefault",

"PixelHit",
"PixelDestroy",
"PixelDisconnect",
"PixelExplodeDefault",
"MetalHit",
"MetalDestroy",
"MetalDisconnect",
"PlantHit",
"PlantDestroy",
"PlantDisconnect",
"FuseFleshHit",
"FuseFleshDestroy",
"FuseFleshDisconnect",
"FleshHit",
"FleshDestroy",
"FleshDisconnect",
"StoneHit",
"StoneDestroy",
"StoneDisconnect",
"GlassHit",
"GlassDestroy",
"GlassDisconnect",

"IncreaseProgress",
"IncreaseProgressTick",
"TutorialStateIncrease",

"BombCharge",
"BombExplode",

"PartHit",
"PartShield",
"PartDestroyed",

"PixelIgnite",
"PixelExplode",
"ExplosiveHitWithoutDamage",
"LaserHit",

"Charge0",
"Charge1",
"ChargeAscend",
"ChargeAscend2",
"ChargeWhoosh",
"ChargeBomb",
"CockGun0",

"ShootBlaster",
"ShootBlaster2",
"ShootBig",
"ShootSniper",
"ShootSniperDeep",
"ShootStaticLaser",
"ShootStaticLaserLongAF",
"ShootCannon",
"ShootEnergy",
"ShootPump",
"ShootForce",
"ShootBomb",

"ShootSmallOrganic",
"ShootPhasor",
"ShootBwomp",
"ShootChunkyError",
"ShootSqueakyToy",
"ShootBlow",
"ShootThicko",
"ShootDart",
"ShootAirMute",
"ShootLaserThump",
"ShootResonant",
"ShootWarp",
"ShootLittleRattle",
"ShootLaserBounce",
"ShootPow",
"ShootMetalWarp",
"ShootEvilPhaser",
"ShootGhost",
"ShootSoftWomp",
"ShootMechanical",
"ShootSplash",
"ShootSquelch",
"ShootSoft",
"ShootBigEnergy",

"ExplosionWarps",
"ExplosionComputerError",
"ExplosionDeepMuted",
"ExplosionDeepResonant",
"ExplosionDeepKnockKnock",
"ExplosionBadGame",
"ExplosionSwish",
"ExplosionOverclocked",
"ExplosionFirework",
"ExplosionDrained",

"SawLoop",
"EnergyWavesLoop",
"EnergyWaveLoop",
"MagnetLoop",
"LightningStart",
"LightningStrike",
"FieldWarning",
"TargetLinePip",
"GlassShatter",
"AlienWail",
"LightningOrb",
"BulletLand",
"Kick",
"MechanismClick",
"ShootBurst",

"PowerupGet",
"PowerupSelect",
"PowerupUse",
"PowerupActiveBoostGet",
"PowerupActiveBoostSelect",
"PowerupActiveBoostUse",
"PowerupAirburstGet",
"PowerupAirburstSelect",
"PowerupAirburstUse",
"PowerupAirburstExplode",
"PowerupBlinkGet",
"PowerupBlinkSelect",
"PowerupBlinkUse",
"PowerupBumperGet",
"PowerupBumperSelect",
"PowerupBumperUse",
"PowerupCannonGet",
"PowerupCannonSelect",
"PowerupCannonUse",
"PowerupCannonHit",
"PowerupCarveGet",
"PowerupCarveSelect",
"PowerupCarveUse",
"PowerupCarveHit",
"PowerupConvertGet",
"PowerupConvertSelect",
"PowerupConvertUse",
"PowerupDoubleGunGet",
"PowerupDoubleGunSelect",
"PowerupDoubleGunUse",
"PowerupDroneGet",
"PowerupDroneSelect",
"PowerupDroneUse",
"PowerupEraseGet",
"PowerupEraseSelect",
"PowerupEraseUse",
"PowerupFadeGet",
"PowerupFadeSelect",
"PowerupFadeUse",
"PowerupFreezeGet",
"PowerupFreezeSelect",
"PowerupFreezeUse",
"PowerupRepelGet",
"PowerupRepelSelect",
"PowerupRepelUse",
"PowerupShieldGet",
"PowerupShieldBreak",
"PowerupShieldZoneGet",
"PowerupShieldZoneSelect",
"PowerupShieldZoneUse",
"PowerupSliceGet",
"PowerupSliceSelect",
"PowerupSliceUse",
"PowerupSliceHit",
"PowerupSlowmoGet",
"PowerupSlowmoSelect",
"PowerupSlowmoUse",
"PowerupSweepGet",
"PowerupSweepSelect",
"PowerupSweepUse",
"PowerupTurretGet",
"PowerupTurretSelect",
"PowerupTurretUse",
"PowerupFFDGet",
"PowerupFFDSelect",
"PowerupFFDUse",

"AsteroidImplodeFinish1",
"AsteroidImplodeFinish2",

"IntroBossSpawn",
"IntroBossDie",
"IntroBossSpeech",
"IntroBossSpokesCharge",
"IntroBossSpokesCharge2",
"IntroBossSpokesShoot",
"IntroBossImplodeStart",
"IntroBossImplodeFinish",
"IntroBossRevengeBulletSpawn",

"OctopusBossSpawn",
"OctopusBossDie",
"OctopusBossSpeech",
"OctopusBossStageStart",
"OctopusStageWave",
"OctopusLazyCharge",
"OctopusLazyShoot",
"OctopusBubbleShoot",
"OctopusF0SpiralCharge",
"OctopusF0SpiralShoot",
"OctopusMineReload",
"OctopusMineShoot",
"OctopusFloatingMineReload",
"OctopusFloatingMineShoot",
"OctopusFloatingMineExplode",
"OctopusF1SmallSpreadCharge",
"OctopusF1SmallSpreadShoot",
"OctopusF1OrbCharge",
"OctopusF1OrbShoot",
"OctopusF1OrbDropMine",
"OctopusBubbleOrbCharge",
"OctopusBubbleOrbShoot",
"OctopusBubbleOrbReleaseBubble",
"OctopusSmallSpewCharge",
"OctopusSmallSpewShoot",
"OctopusTurretSpawn",
"BubblePop",

"MechBossSpawn",
"MechBossDie",
"MechBossSpeech",
"MechTurretSpeech",
"MechBossStageStart",
"MechBossSpokesCharge",
"MechBossSpokesShoot",
"MechBossSpokesShootMed",
"MechBossSpokesShootFast",
"MechBossDirectCharge",
"MechTurretSpawn",
"MechBallsBeep",

"FuseBossSpawn",
"FuseBossDie",
"FuseBossSpeech",
"FuseBossStageStart",
"FuseMinionSpeech",
"FuseEnemyEnraged",
"FuseBossShootPew0",
"FuseBossShootPew1",
"FuseBossChargePump",
"FuseBossShootPump",
"FuseBossTossedLand",
"FuseBossChargeDirect",
"FuseBossShootDirect",
"FuseBossChargeSimple",
"FuseBossShootSimple",
"FuseEnemyImplodeFinish",
"FuseEnemyWarpIn",
"FuseEnemyWarpIn2",
"FuseEnemySpawn",
"FuseTriggerHit1",
"FuseTriggerHit2",
"FuseTriggerHit3",
"Confuse",
"ConfuseEnd",

"TrenchBossSpawn",
"TrenchBossDie",
"TrenchBossSpeech",
"TrenchBossStageStart",
"TrenchCurveSpokes",
"TrenchSurroundingCircle",
"TrenchSurroundingCircle2",
"TrenchExpandingSpawn",
"TrenchExpandingDie",
"TrenchExpandingHit",
"VineStrangle",
"VineRip",
"CrawlerPlant",
"CrawlerPlant2",


"OnionBossSpawn",
"OnionBossDie",
"OnionBossSpeech",
"OnionBossStageStart",
"OnionGrid2Spawn",
"OnionGrid2Whoosh",
"OnionGrid3Beep",
"OnionGrid3Whoosh",

"HunterBossSpawn",
"HunterBossDie",
"HunterBossSpeech",
"HunterBossStageStart",
"HunterCharge",
"HunterBombStart",
"HunterBombExplode",
"HunterShootDiamond",
"HunterSpokesShoot",
"HunterParallelCharge",
"HunterWormCharge",
"HunterWormShoot",
"HunterRandomTriangles",
"HunterLandmineShoot",
"HunterLandmineExplode",
"HunterTrailChildShoot",

"TentacleBossSpawn",
"TentacleBossDie",
"TentacleBossSpeech",
"TentacleBossStageStart",
"TentacleUnitSpawn",
"TentacleGreenBulletShoot",
"TentacleShootPew0",
"TentacleCentipedeCharge",
"TentacleCentipedeShoot",
"TentacleCentipedeDie",
"TentacleStickyCharge",
"TentacleStickyHit",
"TentacleWaveShoot",
"TentacleWobblingShoot",
"TentacleSpiralShoot",
"TentacleRoundRainShoot",
"TentacleOrbCharge",
"TentacleOrbShoot",
"TentacleOrbFire",

"ClawBossSpawn",
"ClawBossDie",
"ClawBossSpeech",
"ClawBossStageStart",
"ClawPopcornShoot",
"ClawFireworkShoot",
"ClawFireworkExplode",
"ClawSpikesStart",
"ClawSpinner",
"SpongeHit",
"SpongeVanish",

"OrbBossSpawn",
"OrbBossDie",
"OrbBossSpeech",
"OrbBossStageStart",
"OrbMeteorSpawn",
"OrbInnerSpiralShoot",
"OrbLaserShoot",

"FrameBossSpawn",
"FrameBossDie",
"FrameBossSpeech",
"FrameBossStageStart",
"FrameBouncerHitWall",
"FrameMeteorLand",
"FrameTrailShoot",
"FrameTrailChild",
"FrameTrailFinish",
"FrameFireworkFuse",
"FrameFireworkExplode",
"FrameToggleSwitchEngage",
"FrameToggleDangerSpawned",

"LaserBossSpawn",
"LaserBossDie",
"LaserBossSpeech",
"LaserBossStageStart",
"LaserSpewSmallCharge",
"LaserSpewSmallShoot",
"LaserSpewBigCharge",
"LaserSpewBigShoot",
"LaserCrosshairCharge",
"LaserCrosshairShoot1",
"LaserCrosshairShoot2",
"LaserCrosshairCollide",
"LaserWeirdShoot",
"LaserDiamondSkullCircleCharge",
"LaserDiamondSkullCircleShoot",
"LaserDiamondSkullCircle2Charge",
"LaserDiamondSkullCircle2Shoot",
"LaserWeirdShoot2",
"LaserUnitLaserOn",
"LaserPetSpewSmallCharge",
"LaserPetSpewSmallShoot",

"StormBossSpawn",
"StormBossDie",
"StormBossSpeech",
"StormBossStageStart",
"StormReturnTransform",
"StormMeteorWarning",
"StormMeteorLand",
"StormMeteorBulletHitPlayer",
"StormMissileShoot",
"StormQuickLaserShoot",
"StormSlalom1Shoot",
"StormSlalom2Shoot",
"StormSpinnerChildShoot",
"StormSpinnerLifetimeFinished",
"ThreeBodyZap",

"InvasionBossSpawn",
"InvasionBossDie",
"InvasionBossSpeech",
"InvasionBossStageStart",
"InvasionCircleSpokesShoot",
"InvasionTrackSpokesShoot",
"InvasionCubeDiamondShoot",
"InvasionDiamondShoot",
"InvasionXSpawn",
"InvasionXAttack",
"InvasionShip1Speech",
"InvasionShip2Speech",
"InvasionShip2Charge",
"InvasionShip3Speech",
"InvasionBossWarning",
"InvasionBossShootPew0",
"InvasionBossShootPew1",
"InvasionBossShootDirect",
"InvasionBossChargeShip3",
"InvasionBossSpawnShip3",
"InvasionTrailChildBullet",

"Thud",
"Thud2",
"Thud3",
"Thud4",
"Thump",

"AllPrereqsDestroyed",
"CurseCharge",
"CurseShoot",
"CurseWarning",

"PowerupCharge",
"PowerupShoot",
"PowerupEmerge",
"TurretShoot",

"LaserCharge",
"LaserLoop",
"FollowingLoop",

"TrapLand",
"TrapLoop",
"TrapBeep",
"TrapExplode",
"TrapImplodeStart",
"TrapImplodeFinish",

"TrapLand2",
"TrapImplodeStart2",

"EggLand",
"EggImplodeStart",
"EggImplodeFinish",

"SliderActivated",
"SliderEnemySpawn",
"SliderEnemyChargeTossed",
"SliderEnemyTossedLand",
"SafeSpaceWarning",
"SafeSpaceCharge",
"SafeSpaceLoop",
"SafeSpaceLand",
"WeirdHomingMove",
"SliderEnemyRevengeBulletSpawn",

"UIButtonHover",
"UIButtonClick",
"UIButtonClickForward",
"UIButtonClickBack",
"UIStageHover",
"UIStageSwitch",
"UIStageStart",
"UISoftHover",
"UIMenuHover",
"UIMenuClick",
"UIDragClick",
"UIDragLoop",
"UIDragRelease",
"UIToggleOn",
"UIToggleOff",
"UISubmenuHover",
"UISubmenuClick",
"UITinyHover",
"UITinyClick",

Download sfx audio files

sfx.zip

Custom SFX

You can also create a new json file to define custom sounds.

This is sfx.json from the example plugin.

{
    "ExampleStage":  { 
        "volume": 1, 
        "pitchMin": 0.9, 
        "pitchMax": 1.2, 
        "maxDistance": 200, 
        "priority": 200, 
        "fileName": "sfx/example_stage", 
    },

    "Victory":  { "volume": 1, "pitchMin": 0.85, "pitchMax": 1.3, "maxDistance": 300, "priority": 200, "fileName": "sfx/victory", },
}

The filename property specifies that example_stage.wav is located in a folder called sfx located in the plugin folder.
The maxDistance property can make unimportant sounds not play if they are too far from the player.
The priority property isn't very important, but setting a lower priority means that those sounds will be skipped in the event that the audio engine is overloaded with sounds in a short period of time.

Trigger your custom sfx in the same way as the built-in sounds:

1	{ "action": "CallMethod", "target":"stage", "method": "PlaySfx", "params": { "sfxType": "ExampleStage", }},

Don't forget to include the path to you sfx file(s) in your plugin.json file.

{
  // load files from sfx.json, in the same folder as plugin.json
  "sounds": [ "sfx" ],
}

Looping SFX

Looping sounds can be useful for lasers and other things that persist for a certain amount of time.

Call the stage's StartLoopingSfx action, storing the return value in an integer property. This value identifies the particular looping sound being created.
Change the properties of the sound over time using SetLoopingSfxPosition, SetLoopingSfxVolume, SetLoopingSfxPitch, and SetLoopingSfxMaxDistance. These actions require you to pass in the ID of the looping sound you want to modify.
Call StopLoopingSfx to end the looping sound.

{
    // pattern stuff ...

    "properties": { "sfxId": { "type": "Int" }, },
    "onStart":[
      { "action": "CallMethod", "target": "stage", "method": "StartLoopingSfx", "params": { "sfxType":"LaserLoop", "pos":"vec2(0f, 0f)", }, "return":"sfxId" },
      { "action": "CallMethod", "target": "stage", "method": "SetLoopingSfxVolume", "params": { "id":"sfxId", "volume":0, }, },
    ],
    "onUpdate":[
      { "action": "CallMethod", "target": "stage", "method": "SetLoopingSfxVolume", "params": { "id":"sfxId", "volume":"patternTime < 4.75f ? map(patternTime, 1.5f, 1.75f, 0f, 1f, 'QuadOut') : map(patternTime, 4.75f, 5f, 1f, 0f)", }, },
      { "action": "CallMethod", "target": "stage", "method": "SetLoopingSfxPosition", "params": { "id":"sfxId", "pos":"projectPointOntoLine(playerPos, patternPos + patternDir * 10f, patternPos + patternDir * 500f)", }, },
    ],
    "onFinish":[
      { "action": "CallMethod", "target": "stage", "method": "StopLoopingSfx", "params": { "id":"sfxId", }, },
    ],
}

In this example, the ID of the looping sound is stored in a custom integer property of a pattern. You could also store it in the built-in intVar of bullets, for example.