https://github.com/phasereditor2d/phasereditor2d-scripts-timer
https://github.com/phasereditor2d/phasereditor2d-scripts-timer
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/phasereditor2d/phasereditor2d-scripts-timer
- Owner: PhaserEditor2D
- License: mit
- Created: 2023-12-02T12:11:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T01:20:47.000Z (over 2 years ago)
- Last Synced: 2025-06-27T10:05:57.271Z (12 months ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.MD
- License: LICENSE
Awesome Lists containing this project
README
# Phaser Editor 2D Timer Scripts (library)
This project contains Phaser Editor 2D scripts for using a timer.
These script nodes are very basic and may fit on any Phaser Editor 2D project.
The scripts are coded in TypeScript with ES modules.
## Installing (NPM)
This package depends on the following packages:
- `@phasereditor2d/scripts-core`
- `@phasereditor2d/scripts-random`
To install this in your game you have to install dependencies too:
```
npm install @phasereditor2d/scripts-core
npm install @phasereditor2d/scripts-random
npm install @phasereditor2d/scripts-timer
```
Also, you should add this package to the `phasereditor2d.config.json` file in your project, in the `scripts` section:
```json
{
"scripts": [
"@phasereditor2d/scripts-core",
"@phasereditor2d/scripts-random",
"@phasereditor2d/scripts-timer"
]
}
```
## Installing (vanilla JavaScript)
* Get the files in the [browser](./browser/) folder and copy them into your JavaScript project. It includes Phaser Editor 2D files, JavaScript files, and TypeScript type definitions.
* Add a `script` tag to the `index.html` file to load the `lib/phasereditor2d_scripts_timer.js` file.
## Summary
This library provides a few actions for implementing timers in your game.
As a reminder, an action is executed by an event script or another action.
The actions:
* **Delay Action** - Delays, then executes the children's scripts.
* **Delay Random Action** - Delays a random time, then executes the children's
* **Emit Tick Action** - Emits a tick at every given delay.
* **Emit Random Tick Action** - Emits a tick always at a random delay.
## Delay Action
*Class: DelayActionScript*
This action delays a given **Delay** time and then executes the children's scripts.
This action allows the **Target Action Config** user component.
## Delay Random Action
*Class: DelayRandomActionScript*
This action delays a random time and then executes the children's scripts.
The delay is a random value generated by any of the random user component configurations in the [@phasereditor2d/scripts-random](https://github.com/PhaserEditor2D/phasereditor2d-scripts-random) library.
This action allows the **Target Action Config** user component.
## Emit Tick Action Script
*Class: EmitTickActionScript*
This action emits a tick at a fixed rate, within the given **Delay**. At every tick, it executes the children's scripts.
This action allows the **Target Action Config** user component.
## Emit Random Tick Action
*Class: EmitRandomTickActionScript*
This action emits a tick at a random rate. At every tick, it executes the children's scripts.
The delay is a random value generated by any of the random user component configurations in the [@phasereditor2d/scripts-random](https://github.com/PhaserEditor2D/phasereditor2d-scripts-random) library.
This action allows the **Target Action Config** user component.