Methods
(inner) call_with_delay(delay, group)
- Description:
- Calls a group with a delay
- Source:
Parameters:
| Name |
Type |
Description |
delay |
number
|
How much to delay by |
group |
group
|
Group to call |
(inner) equal_to(counter, other) → {condition}
- Description:
- Returns a equal to condition
- Source:
Parameters:
| Name |
Type |
Description |
counter |
counter
|
Counter to compare to number |
other |
number
|
Number to be compared to counter |
Returns:
-
Type
-
condition
(inner) for_loop(range, fn, delayopt)
- Description:
- Loops a function a specific amount of times (defined by range)
- Source:
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
range |
array
|
|
|
Range of numbers defining how many times to loop fn by |
fn |
function
|
|
|
Function to loop |
delay |
number
|
<optional>
|
0.05
|
How much to delay between cycle |
(inner) frame_loop(trigger_function) → {group}
- Description:
- Creates a loop that repeats every frame
- Source:
Parameters:
| Name |
Type |
Description |
trigger_function |
group
|
The group to call every frame |
Returns:
Group that can be used to stop the loop
-
Type
-
group
(inner) frames(frames)
- Description:
- Waits a specific amount of frames
- Source:
Parameters:
| Name |
Type |
Description |
frames |
number
|
How many frames to wait for |
(inner) greater_than(counter, other) → {condition}
- Description:
- Returns a greater than condition
- Source:
Parameters:
| Name |
Type |
Description |
counter |
counter
|
Counter to compare to number |
other |
number
|
Number to be compared to counter |
Returns:
-
Type
-
condition
(inner) less_than(counter, other) → {condition}
- Description:
- Returns a less than condition
- Source:
Parameters:
| Name |
Type |
Description |
counter |
counter
|
Counter to compare to number |
other |
number
|
Number to be compared to counter |
Returns:
-
Type
-
condition
(inner) remappable(fn) → {function}
- Description:
- Creates trigger function-like systems, but can be called normally with item IDs as arguments (e.g. a remappable can be called like `my_remappable(counter1.item)`)
- Source:
Parameters:
| Name |
Type |
Description |
fn |
function
|
Function that remappable uses |
Returns:
Function to call
-
Type
-
function
(inner) sequence(sequence, modeopt, min_intopt, resetopt) → {function}
- Description:
- Implementation of sequence trigger
- Source:
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
sequence |
array
|
|
|
Sequence of groups to be called (e.g. [[group(1), 1], [group(2), 1]] is a valid input) |
mode |
number
|
<optional>
|
0
|
Mode of sequence trigger (0 = stop, 1 = loop, 2 = last) |
min_int |
number
|
<optional>
|
0
|
MinInt of sequence trigger |
reset |
number
|
<optional>
|
0
|
Reset of sequence trigger (0 = full, 1 = step) |
Returns:
Function that steps through the sequence once
-
Type
-
function
(inner) spawn_trigger(group, time) → {object}
- Description:
- Creates a spawn trigger and returns it
- Source:
Parameters:
| Name |
Type |
Default |
Description |
group |
group
|
|
group to be spawned |
time |
number
|
0
|
delay to spawn group |
Returns:
-
Type
-
object