Types/TipTrigger: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎BuildEntityTipTrigger: 1.1.40: linear_power_pole_line added)
m (words)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
A [[Types/table]] that is loaded as one of the below listed types, depending on the value of the <code>type</code> key in the table.
Used by [[Prototype/TipsAndTricksItem]]. A [[Types/table]] that is loaded as one of the below listed types, depending on the value of the <code>type</code> key in the table.


<code>type</code> is a mandatory member of the table and of type [[Types/string|string]]. It may have one of the following values:
<code>type</code> is a mandatory member of the table and of type [[Types/string|string]]. It may have one of the following values:
* <code>"or"</code> is loaded as a [[#OrTipTrigger|OrTipTrigger]]  
* <code>"or"</code> is loaded as a [[#OrTipTrigger|OrTipTrigger]]
* <code>"and"</code> is loaded as a [[#AndTipTrigger|AndTipTrigger]]  
* <code>"and"</code> is loaded as a [[#AndTipTrigger|AndTipTrigger]]
* <code>"sequence"</code> is loaded as a [[#SequenceTipTrigger|SequenceTipTrigger]]  
* <code>"sequence"</code> is loaded as a [[#SequenceTipTrigger|SequenceTipTrigger]]
* <code>"dependencies-met"</code> is loaded as a [[#DependenciesMetTipTrigger|DependenciesMetTipTrigger]]  
* <code>"dependencies-met"</code> is loaded as a [[#DependenciesMetTipTrigger|DependenciesMetTipTrigger]]
* <code>"time-elapsed"</code> is loaded as a [[#TimeElapsedTipTrigger|TimeElapsedTipTrigger]]  
* <code>"time-elapsed"</code> is loaded as a [[#TimeElapsedTipTrigger|TimeElapsedTipTrigger]]
* <code>"research"</code> is loaded as a [[#ResearchTechnologyTipTrigger|ResearchTechnologyTipTrigger]]  
* <code>"research"</code> is loaded as a [[#ResearchTechnologyTipTrigger|ResearchTechnologyTipTrigger]]
* <code>"unlocked-recipe"</code> is loaded as a [[#UnlockedRecipeTipTrigger|UnlockedRecipeTipTrigger]]  
* <code>"unlock-recipe"</code> is loaded as a [[#UnlockRecipeTipTrigger|UnlockRecipeTipTrigger]]
* <code>"craft-item"</code> is loaded as a [[#CraftItemTipTrigger|CraftItemTipTrigger]]  
* <code>"craft-item"</code> is loaded as a [[#CraftItemTipTrigger|CraftItemTipTrigger]]
* <code>"build-entity"</code> is loaded as a [[#BuildEntityTipTrigger|BuildEntityTipTrigger]]  
* <code>"build-entity"</code> is loaded as a [[#BuildEntityTipTrigger|BuildEntityTipTrigger]]
* <code>"manual-transfer"</code> is loaded as a [[#ManualTransferTipTrigger|ManualTransferTipTrigger]]  
* <code>"manual-transfer"</code> is loaded as a [[#ManualTransferTipTrigger|ManualTransferTipTrigger]]
* <code>"stack-transfer"</code> is loaded as a [[#StackTransferTipTrigger|StackTransferTipTrigger]]  
* <code>"stack-transfer"</code> is loaded as a [[#StackTransferTipTrigger|StackTransferTipTrigger]]
* <code>"entity-transfer"</code> is loaded as a [[#EntityTransferTipTrigger|EntityTransferTipTrigger]]  
* <code>"entity-transfer"</code> is loaded as a [[#EntityTransferTipTrigger|EntityTransferTipTrigger]]
* <code>"set-recipe"</code> is loaded as a [[#SetRecipeTipTrigger|SetRecipeTipTrigger]]  
* <code>"set-recipe"</code> is loaded as a [[#SetRecipeTipTrigger|SetRecipeTipTrigger]]
* <code>"limit-chest"</code> is loaded as a [[#LimitChestTipTrigger|LimitChestTipTrigger]]  
* <code>"set-filter"</code> is loaded as a [[#SetFilterTipTrigger|SetFilterTipTrigger]]
* <code>"use-pipette"</code> is loaded as a [[#UsePipetteTipTrigger|UsePipetteTipTrigger]]  
* <code>"limit-chest"</code> is loaded as a [[#LimitChestTipTrigger|LimitChestTipTrigger]]
* <code>"set-logistic-request"</code> is loaded as a [[#SetLogisticRequestTipTrigger|SetLogisticRequestTipTrigger]]  
* <code>"use-pipette"</code> is loaded as a [[#UsePipetteTipTrigger|UsePipetteTipTrigger]]
* <code>"use-confirm"</code> is loaded as a [[#UseConfirmTipTrigger|UseConfirmTipTrigger]]  
* <code>"set-logistic-request"</code> is loaded as a [[#SetLogisticRequestTipTrigger|SetLogisticRequestTipTrigger]]
* <code>"low-power"</code> is loaded as a [[#LowPowerTipTrigger|LowPowerTipTrigger]]  
* <code>"use-confirm"</code> is loaded as a [[#UseConfirmTipTrigger|UseConfirmTipTrigger]]
* <code>"paste-entity-settings"</code> is loaded as a [[#PasteEntitySettingsTipTrigger|PasteEntitySettingsTipTrigger]]  
* <code>"low-power"</code> is loaded as a [[#LowPowerTipTrigger|LowPowerTipTrigger]]
* <code>"fast-replace"</code> is loaded as a [[#FastReplaceTipTrigger|FastReplaceTipTrigger]]  
* <code>"paste-entity-settings"</code> is loaded as a [[#PasteEntitySettingsTipTrigger|PasteEntitySettingsTipTrigger]]
* <code>"fast-replace"</code> is loaded as a [[#FastReplaceTipTrigger|FastReplaceTipTrigger]]
* <code>"group-attack"</code> is loaded as a [[#GroupAttackTipTrigger|GroupAttackTipTrigger]]
* <code>"group-attack"</code> is loaded as a [[#GroupAttackTipTrigger|GroupAttackTipTrigger]]
* <code>"fast-belt-bend"</code> is loaded as a [[#FastBeltBendTipTrigger|FastBeltBendTipTrigger]]
* <code>"belt-traverse"</code> is loaded as a [[#BeltTraverseTipTrigger|BeltTraverseTipTrigger]]
* <code>"place-equipment"</code> is loaded as a [[#PlaceEquipmentTipTrigger|PlaceEquipmentTipTrigger]]
* <code>"clear-cursor"</code> is loaded as a [[#ClearCursorTipTrigger|ClearCursorTipTrigger]]
* <code>"shift-build"</code> is loaded as a [[#ShiftBuildTipTrigger|ShiftBuildTipTrigger]]
* <code>"gate-over-rail-build"</code> is loaded as a [[#GateOverRailBuildTipTrigger|GateOverRailBuildTipTrigger]]
* <code>"manual-wire-drag"</code> is loaded as a [[#ManualWireDragTipTrigger|ManualWireDragTipTrigger]]




Line 63: Line 71:
Name of a [[Prototype/Technology]]. Mandatory.
Name of a [[Prototype/Technology]]. Mandatory.


== UnlockedRecipeTipTrigger ==
== UnlockRecipeTipTrigger ==
<code>type = "unlocked-recipe"</code>
<code>type = "unlock-recipe"</code>
=== recipe ===
=== recipe ===
'''Type''': [[Types/string]]
'''Type''': [[Types/string]]
Line 75: Line 83:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 119: Line 127:
=== build_by_dragging ===
=== build_by_dragging ===
'''Type''': [[Types/bool]]
'''Type''': [[Types/bool]]
'''Default''': false


Optional.
Optional.
Line 132: Line 138:


=== linear_power_pole_line ===
=== linear_power_pole_line ===
'''Type''': [[Types/bool]]
'''Default''': false
Optional.
=== build_in_line ===
'''Type''': [[Types/bool]]
'''Type''': [[Types/bool]]


Line 143: Line 156:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 152: Line 165:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 168: Line 181:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 184: Line 197:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 209: Line 222:


'''Default''': any (= it does not matter)
'''Default''': any (= it does not matter)
Optional.
== SetFilterTipTrigger ==
<code>type = "set-filter"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
=== entity ===
'''Type''': [[Types/string]]
Name of a [[Prototype/Entity]]. Optional.
=== match_type_only ===
'''Type''': [[Types/bool]]
'''Default''': false
Optional.
=== consecutive ===
'''Type''': [[Types/bool]]
'''Default''': false


Optional.
Optional.
Line 217: Line 258:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 226: Line 267:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 235: Line 276:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 251: Line 292:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 260: Line 301:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 269: Line 310:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 295: Line 336:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1


Optional.
Optional.
Line 321: Line 362:
'''Type''': [[Types/uint32]]
'''Type''': [[Types/uint32]]


'''Default''': 0
'''Default''': 1
 
Optional.
 
== FastBeltBendTipTrigger ==
<code>type = "fast-belt-bend"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
== BeltTraverseTipTrigger ==
<code>type = "belt-traverse"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
== PlaceEquipmentTipTrigger ==
<code>type = "place-equipment"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
=== equipment ===
'''Type''': [[Types/string]]
 
Name of a [[Prototype/Equipment]]. Optional.
 
== ClearCursorTipTrigger ==
<code>type = "clear-cursor"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
== ShiftBuildTipTrigger ==
<code>type = "shift-build"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
== GateOverRailBuildTipTrigger ==
<code>type = "gate-over-rail-build"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
Optional.
 
== ManualWireDragTipTrigger ==
<code>type = "manual-wire-drag"</code>
=== count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 1


Optional.
Optional.

Latest revision as of 11:19, 3 December 2021

Used by Prototype/TipsAndTricksItem. A Types/table that is loaded as one of the below listed types, depending on the value of the type key in the table.

type is a mandatory member of the table and of type string. It may have one of the following values:


OrTipTrigger

type = "or"

triggers

Type: Types/table of Types/TipTrigger

Array of other tip triggers, if at least one of them is fulfilled, this tip trigger is considered fulfilled.

AndTipTrigger

type = "and"

triggers

Type: Types/table of Types/TipTrigger

Array of other tip triggers, if all of them are fulfilled, this tip trigger is considered fulfilled.

SequenceTipTrigger

type = "sequence"

triggers

Type: Types/table of Types/TipTrigger

Array of other tip triggers.

DependenciesMetTipTrigger

type = "dependencies-met" This tip trigger is considered fulfilled when the dependencies of the Prototype/TipsAndTricksItem are fulfilled.

TimeElapsedTipTrigger

type = "time-elapsed"

ticks

Type: Types/uint32

ResearchTechnologyTipTrigger

type = "research"

technology

Type: Types/string

Name of a Prototype/Technology. Mandatory.

UnlockRecipeTipTrigger

type = "unlock-recipe"

recipe

Type: Types/string

Name of a Prototype/Recipe. Mandatory.

CraftItemTipTrigger

type = "craft-item"

count

Type: Types/uint32

Default: 1

Optional.

item

Type: Types/string

Name of a Prototype/Item. Optional.

consecutive

Type: Types/bool

Default: false

Optional. Can only be used with event_type "crafting-finished".

event_type

Type: Types/string

Mandatory. One of "crafting-of-single-item-ordered", "crafting-of-multiple-items-ordered" or "crafting-finished".

BuildEntityTipTrigger

type = "build-entity"

count

Type: Types/uint32

Default: 1

Optional.

entity

Type: Types/string

Name of a Prototype/Entity. Optional.

match_type_only

Type: Types/bool

Default: false

Optional.

build_by_dragging

Type: Types/bool

Optional.

consecutive

Type: Types/bool

Default: false

Optional. Building is considered consecutive when the built entity is the same as the last built entity.

linear_power_pole_line

Type: Types/bool

Default: false

Optional.

build_in_line

Type: Types/bool

Default: false

Optional.

ManualTransferTipTrigger

type = "manual-transfer"

count

Type: Types/uint32

Default: 1

Optional.

StackTransferTipTrigger

type = "stack-transfer"

count

Type: Types/uint32

Default: 1

Optional.

transfer

Type: Types/string

Default: any transfer

Optional. One of "stack", "inventory" or "whole-inventory".

EntityTransferTipTrigger

type = "entity-transfer"

count

Type: Types/uint32

Default: 1

Optional.

transfer

Type: Types/string

Default: any transfer

Optional. One of "in" or "out".

SetRecipeTipTrigger

type = "set-recipe"

count

Type: Types/uint32

Default: 1

Optional.

recipe

Type: Types/string

Name of a Prototype/Recipe. Optional.

machine

Type: Types/string

Name of a Prototype/Entity. Optional.

consecutive

Type: Types/bool

Default: false

Optional.

uses_fluid

Type: Types/bool

Default: any (= it does not matter)

Optional.

SetFilterTipTrigger

type = "set-filter"

count

Type: Types/uint32

Default: 1

Optional.

entity

Type: Types/string

Name of a Prototype/Entity. Optional.

match_type_only

Type: Types/bool

Default: false

Optional.

consecutive

Type: Types/bool

Default: false

Optional.

LimitChestTipTrigger

type = "limit-chest"

count

Type: Types/uint32

Default: 1

Optional.

UsePipetteTipTrigger

type = "use-pipette"

count

Type: Types/uint32

Default: 1

Optional.

SetLogisticRequestTipTrigger

type = "set-logistic-request"

count

Type: Types/uint32

Default: 1

Optional.

logistic_chest_only

Type: Types/bool

Default: false

Optional.

UseConfirmTipTrigger

type = "use-confirm"

count

Type: Types/uint32

Default: 1

Optional.

LowPowerTipTrigger

type = "low-power"

count

Type: Types/uint32

Default: 1

Optional.

PasteEntitySettingsTipTrigger

type = "paste-entity-settings"

count

Type: Types/uint32

Default: 1

Optional.

source

Type: Types/string

Name of a Prototype/Entity. Optional.

target

Type: Types/string

Name of a Prototype/Entity. Optional.

match_type_only

Type: Types/bool

Default: false

Optional.

FastReplaceTipTrigger

type = "fast-replace"

count

Type: Types/uint32

Default: 1

Optional.

source

Type: Types/string

Name of a Prototype/Entity. Optional.

target

Type: Types/string

Name of a Prototype/Entity. Optional.

match_type_only

Type: Types/bool

Default: false

Optional.

GroupAttackTipTrigger

type = "group-attack"

count

Type: Types/uint32

Default: 1

Optional.

FastBeltBendTipTrigger

type = "fast-belt-bend"

count

Type: Types/uint32

Default: 1

Optional.

BeltTraverseTipTrigger

type = "belt-traverse"

count

Type: Types/uint32

Default: 1

Optional.

PlaceEquipmentTipTrigger

type = "place-equipment"

count

Type: Types/uint32

Default: 1

Optional.

equipment

Type: Types/string

Name of a Prototype/Equipment. Optional.

ClearCursorTipTrigger

type = "clear-cursor"

count

Type: Types/uint32

Default: 1

Optional.

ShiftBuildTipTrigger

type = "shift-build"

count

Type: Types/uint32

Default: 1

Optional.

GateOverRailBuildTipTrigger

type = "gate-over-rail-build"

count

Type: Types/uint32

Default: 1

Optional.

ManualWireDragTipTrigger

type = "manual-wire-drag"

count

Type: Types/uint32

Default: 1

Optional.