Skip to content

Main Navigation

Getting Started

Sonolus.js Guide

Custom Server Specs

Round Multiplayer Server Specs

Background Specs

English (English)

Deutsch (German)

Ελληνικά (Greek)

Español (Spanish)

Français (French)

Bahasa Indonesia (Indonesian)

日本語 (Japanese)

한국어 (Korean)

Português (Portuguese)

Русский (Russian)

Türkçe (Turkish)

Tiếng Việt (Vietnamese)

简体中文 (Simplified Chinese)

繁體中文 (Traditional Chinese)

English (English)

Deutsch (German)

Ελληνικά (Greek)

Español (Spanish)

Français (French)

Bahasa Indonesia (Indonesian)

日本語 (Japanese)

한국어 (Korean)

Português (Portuguese)

Русский (Russian)

Türkçe (Turkish)

Tiếng Việt (Vietnamese)

简体中文 (Simplified Chinese)

繁體中文 (Traditional Chinese)

Theme

Sidebar Navigation

Engine Specs

Introduction

Overview

Frameworks and Tools

Resources

Engine Thumbnail

Engine Configuration

Engine Configuration Option

Engine Configuration UI

Engine Play Data

Engine Play Data Archetype

Engine Watch Data

Engine Watch Data Archetype

Engine Preview Data

Engine Preview Data Archetype

Engine Tutorial Data

Engine Data Bucket

Engine Data Node

Engine Rom

Essentials

Graphics

Audio

Input

Gameplay UI

Performance

Play: Lifecycle

Play: Lifecycle

Early Optimization System

Preprocessing System

Late Optimization System

Spawn Ordering System

Spawning System

Initialization System

Sequential Update System

Input System

Parallel Update System

Despawning System

Presentation System

Play: Blocks

Play: Blocks

Runtime Environment

Runtime Update

Runtime Touch Array

Runtime Skin Transform

Runtime Particle Transform

Runtime Background

Runtime UI

Runtime UI Configuration

Level Memory

Level Data

Level Option

Level Bucket

Level Score

Level Life

Engine Rom

Entity Memory

Entity Data

Entity Shared Memory

Entity Info

Entity Despawn

Entity Input

Entity Data Array

Entity Shared Memory Array

Entity Info Array

Archetype Life

Temporary Memory

Watch: Lifecycle

Watch: Lifecycle

Early Optimization System

Preprocessing System

Late Optimization System

Spawn System

Lifetime System

Sequential Update System

Parallel Update System

Presentation System

Watch: Blocks

Watch: Blocks

Runtime Environment

Runtime Update

Runtime Skin Transform

Runtime Particle Transform

Runtime Background

Runtime UI

Runtime UI Configuration

Level Memory

Level Data

Level Option

Level Bucket

Level Score

Level Life

Engine Rom

Entity Memory

Entity Data

Entity Shared Memory

Entity Info

Entity Input

Entity Data Array

Entity Shared Memory Array

Entity Info Array

Archetype Life

Temporary Memory

Preview: Lifecycle

Preview: Lifecycle

Early Optimization System

Preprocessing System

Late Optimization System

Rendering System

Preview: Blocks

Preview: Blocks

Runtime Environment

Runtime Canvas

Runtime Skin Transform

Runtime UI

Runtime UI Configuration

Preview Data

Preview Option

Engine Rom

Entity Data

Entity Shared Memory

Entity Info

Entity Data Array

Entity Shared Memory Array

Entity Info Array

Temporary Memory

Tutorial: Lifecycle

Tutorial: Lifecycle

Early Optimization System

Preprocessing System

Late Optimization System

Navigate System

Update System

Presentation System

Tutorial: Blocks

Tutorial: Blocks

Runtime Environment

Runtime Update

Runtime Skin Transform

Runtime Particle Transform

Runtime Background

Runtime UI

Runtime UI Configuration

Tutorial Memory

Tutorial Data

Tutorial Instruction

Engine Rom

Temporary Memory

Function Optimizations

Function Optimizations

Mathematical Functions

Block Access Functions

Control Flow Functions

Functions

Abs

Add

And

Arccos

Arcsin

Arctan

Arctan2

BeatToBPM

BeatToStartingBeat

BeatToStartingTime

BeatToTime

Block

Break

Ceil

Clamp

Copy

Cos

Cosh

DebugLog

DebugPause

DecrementPost

DecrementPostPointed

DecrementPostShifted

DecrementPre

DecrementPrePointed

DecrementPreShifted

Degree

DestroyParticleEffect

Divide

DoWhile

Draw

DrawCurvedB

DrawCurvedBT

DrawCurvedL

DrawCurvedLR

DrawCurvedR

DrawCurvedT

Easing Functions

Equal

Execute

Execute0

ExportValue

Floor

Frac

Get

GetPointed

GetShifted

Greater

GreaterOr

HasEffectClip

HasParticleEffect

HasSkinSprite

If

IncrementPost

IncrementPostPointed

IncrementPostShifted

IncrementPre

IncrementPrePointed

IncrementPreShifted

Judge

JudgeSimple

JumpLoop

Lerp

LerpClamped

Less

LessOr

Log

Max

Min

Mod

MoveParticleEffect

Multiply

Negate

Not

NotEqual

Or

Paint

Play

PlayLooped

PlayLoopedScheduled

PlayScheduled

Power

Print

Radian

Random

RandomInteger

Rem

Remap

RemapClamped

Round

Set

SetAdd

SetAddPointed

SetAddShifted

SetDivide

SetDividePointed

SetDivideShifted

SetMod

SetModPointed

SetModShifted

SetMultiply

SetMultiplyPointed

SetMultiplyShifted

SetPointed

SetPower

SetPowerPointed

SetPowerShifted

SetRem

SetRemPointed

SetRemShifted

SetShifted

SetSubtract

SetSubtractPointed

SetSubtractShifted

Sign

Sin

Sinh

Spawn

SpawnParticleEffect

Stack Functions

StackEnter

StackGet

StackGetFrame

StackGetFramePointer

StackGetPointer

StackGrow

StackInit

StackLeave

StackPop

StackPush

StackSet

StackSetFrame

StackSetFramePointer

StackSetPointer

StopLooped

StopLoopedScheduled

Subtract

Switch

SwitchInteger

SwitchIntegerWithDefault

SwitchWithDefault

Tan

Tanh

TimeToScaledTime

TimeToStartingScaledTime

TimeToStartingTime

TimeToTimeScale

Trunc

Unlerp

UnlerpClamped

While

On This Page

`DestroyParticleEffect`

Destroy a particle effect instance.

Arguments

Argument	Description
particleId	Particle effect instance identifier

Return

0.

Pager

Previous PageDegree

Next PageDivide