Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaActiveTriggerPrototype - Runtime Docs

## Class LuaActiveTriggerPrototype extends LuaPrototypeBase

Prototype of an Active Trigger.

Inherits from LuaPrototypeBase

## Members

max_jumps | :: R uint32 | The max number of jumps per trigger. [...]
The max number of jumps per trigger. [...]
max_range_per_jump | :: R double | The max length of jumps. [...]
The max length of jumps. [...]
max_range | :: R double | The max distance jumps are allowed to travel away from the original target. [...]
The max distance jumps are allowed to travel away from the original target. [...]
jump_delay_ticks | :: R uint32 | The tick delay between each jump. [...]
The tick delay between each jump. [...]
fork_chance | :: R double | The chance that a new fork will spawn after each jump [0,1]. [...]
The chance that a new fork will spawn after each jump [0,1]. [...]
max_forks_per_jump | :: R uint32 | The maximum number of forks that can spawn from a single jump. [...]
The maximum number of forks that can spawn from a single jump. [...]
max_forks | :: R uint32 | maximum number of forks allowed to spawn for the entire chain. [...]
maximum number of forks allowed to spawn for the entire chain. [...]
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

Inherited from LuaPrototypeBase

type | :: R string | Type of this prototype.
Type of this prototype.
name | :: R string | Name of this prototype.
Name of this prototype.
order | :: R string | The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name | :: R LocalisedString |
localised_description | :: R LocalisedString |
factoriopedia_description | :: R LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group | :: R LuaGroup | Group of this prototype.
Group of this prototype.
subgroup | :: R LuaGroup | Subgroup of this prototype.
Subgroup of this prototype.
hidden | :: R boolean |
hidden_in_factoriopedia | :: R boolean |
parameter | :: R boolean |
custom_tooltip_fields | :: R array[CustomTooltipField]? | Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

## Attributes

### max_jumps :: Read uint32

The max number of jumps per trigger. default = 5.

### max_range_per_jump :: Read double

The max length of jumps. default = 5.

### max_range :: Read double

The max distance jumps are allowed to travel away from the original target. default = infinity.

### jump_delay_ticks :: Read uint32

The tick delay between each jump. 0 = all jumps instantaneous. default = 0.

### fork_chance :: Read double

The chance that a new fork will spawn after each jump [0,1]. default = 0.

### max_forks_per_jump :: Read uint32

The maximum number of forks that can spawn from a single jump. default = 1.

### max_forks :: Read uint32

maximum number of forks allowed to spawn for the entire chain. default = infinity.

### valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

### object_name :: Read string

The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

- LuaPrototypes::active_trigger