Types/TipTrigger

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/TipTrigger.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

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:

• "or" is loaded as a OrTipTrigger
• "and" is loaded as a AndTipTrigger
• "sequence" is loaded as a SequenceTipTrigger
• "dependencies-met" is loaded as a DependenciesMetTipTrigger
• "time-elapsed" is loaded as a TimeElapsedTipTrigger
• "research" is loaded as a ResearchTechnologyTipTrigger
• "unlock-recipe" is loaded as a UnlockRecipeTipTrigger
• "craft-item" is loaded as a CraftItemTipTrigger
• "build-entity" is loaded as a BuildEntityTipTrigger
• "manual-transfer" is loaded as a ManualTransferTipTrigger
• "stack-transfer" is loaded as a StackTransferTipTrigger
• "entity-transfer" is loaded as a EntityTransferTipTrigger
• "set-recipe" is loaded as a SetRecipeTipTrigger
• "set-filter" is loaded as a SetFilterTipTrigger
• "limit-chest" is loaded as a LimitChestTipTrigger
• "use-pipette" is loaded as a UsePipetteTipTrigger
• "set-logistic-request" is loaded as a SetLogisticRequestTipTrigger
• "use-confirm" is loaded as a UseConfirmTipTrigger
• "low-power" is loaded as a LowPowerTipTrigger
• "paste-entity-settings" is loaded as a PasteEntitySettingsTipTrigger
• "fast-replace" is loaded as a FastReplaceTipTrigger
• "group-attack" is loaded as a GroupAttackTipTrigger
• "fast-belt-bend" is loaded as a FastBeltBendTipTrigger
• "belt-traverse" is loaded as a BeltTraverseTipTrigger
• "place-equipment" is loaded as a PlaceEquipmentTipTrigger
• "clear-cursor" is loaded as a ClearCursorTipTrigger
• "shift-build" is loaded as a ShiftBuildTipTrigger
• "gate-over-rail-build" is loaded as a GateOverRailBuildTipTrigger
• "manual-wire-drag" is loaded as a ManualWireDragTipTrigger

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.