Docs/API Reference

Particle API

Emit and control particle systems.

13 min read Advanced Updated 2026-07-01 v2.0 ~38 min to complete

Introduction

Emit and control particle systems. This page provides a complete guide to particle api in Appley, covering everything from setup to advanced techniques.

API Reference is a core area of Appley. Understanding particle api will help you build better games and use the platform more effectively. This documentation is designed for advanced level users.

Requirements

Before working with particle api, ensure you have the following:

An Appley project with scripts
Familiarity with Appley Scripting syntax
The API reference documentation
Understanding of namespaces (player, world, audio, ui)

Estimated Completion Time

This guide takes approximately 38 minutes to complete. The estimated reading time is 13 minutes. Difficulty level: Advanced.

Step-by-Step Guide

Follow these steps to work with particle api in your Appley project:

Read the documentation

Review the particle api reference in these docs. Note method names and parameters.

Open the Script Editor

Switch to the Script tab in Creator Studio.

Use autocomplete

Type the namespace name and press Ctrl+Space to see available methods.

Write the code

Call the API methods with correct parameters. Check return types.

Test and debug

Use debug.log() to verify API outputs. Fix any errors in diagnostics.

FluxScript Example

Below is an Appley Scripting (Flux Scripting) code example demonstrating particle api:

Particle API — Appley Scripting

// API Reference — Particle API
on start {
  // Player API
  player.setPosition(0, 10, 0)
  player.setHealth(100)
  player.setSpeed(8.0)
  
  // World API
  world.spawn("enemy", 5, 0, 5)
  world.setTime(14, 30)
  
  // Audio API
  audio.play("bgm", { volume: 0.7, loop: true })
  
  // UI API
  ui.setText("label", "Hello")
  ui.setBar("health", 0.8)
  
  // Math API
  dist = math.distance(player.pos, target.pos)
  angle = math.atan2(dy, dx)
  clamped = math.clamp(value, 0, 100)
  
  // Effects API
  effects.spawn("explosion", pos, { scale: 2.0 })
  
  // Save API
  save.set("inventory", inventory)
  data = save.get("inventory")
  
  // Scene API
  scene.load("level2")
}

Node Script Example

The same logic can be implemented using Node Scripting. Here is the equivalent node graph:

Particle API — Node Graph

[On Start] ──► [Player.setPosition]
         ──► [World.spawn: enemy]
         ──► [Audio.play: bgm]
         ──► [UI.setText: label]
         ──► [Math.distance]
         ──► [Effects.spawn: explosion]
         ──► [Save.set: inventory]
         ──► [Scene.load: level2]

Interchangeable Systems

FluxScript and Node Scripting compile to the same runtime. You can mix both in a single project — use whichever is best for each task.