Types/TipTrigger: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
Tag: Replaced
 
Line 2: Line 2:


</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
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>"or"</code> is loaded as a [[#OrTipTrigger|OrTipTrigger]]
* <code>"and"</code> is loaded as a [[#AndTipTrigger|AndTipTrigger]]
* <code>"sequence"</code> is loaded as a [[#SequenceTipTrigger|SequenceTipTrigger]]
* <code>"dependencies-met"</code> is loaded as a [[#DependenciesMetTipTrigger|DependenciesMetTipTrigger]]
* <code>"time-elapsed"</code> is loaded as a [[#TimeElapsedTipTrigger|TimeElapsedTipTrigger]]
* <code>"research"</code> is loaded as a [[#ResearchTechnologyTipTrigger|ResearchTechnologyTipTrigger]]
* <code>"unlock-recipe"</code> is loaded as a [[#UnlockRecipeTipTrigger|UnlockRecipeTipTrigger]]
* <code>"craft-item"</code> is loaded as a [[#CraftItemTipTrigger|CraftItemTipTrigger]]
* <code>"build-entity"</code> is loaded as a [[#BuildEntityTipTrigger|BuildEntityTipTrigger]]
* <code>"manual-transfer"</code> is loaded as a [[#ManualTransferTipTrigger|ManualTransferTipTrigger]]
* <code>"stack-transfer"</code> is loaded as a [[#StackTransferTipTrigger|StackTransferTipTrigger]]
* <code>"entity-transfer"</code> is loaded as a [[#EntityTransferTipTrigger|EntityTransferTipTrigger]]
* <code>"set-recipe"</code> is loaded as a [[#SetRecipeTipTrigger|SetRecipeTipTrigger]]
* <code>"set-filter"</code> is loaded as a [[#SetFilterTipTrigger|SetFilterTipTrigger]]
* <code>"limit-chest"</code> is loaded as a [[#LimitChestTipTrigger|LimitChestTipTrigger]]
* <code>"use-pipette"</code> is loaded as a [[#UsePipetteTipTrigger|UsePipetteTipTrigger]]
* <code>"set-logistic-request"</code> is loaded as a [[#SetLogisticRequestTipTrigger|SetLogisticRequestTipTrigger]]
* <code>"use-confirm"</code> is loaded as a [[#UseConfirmTipTrigger|UseConfirmTipTrigger]]
* <code>"low-power"</code> is loaded as a [[#LowPowerTipTrigger|LowPowerTipTrigger]]
* <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>"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]]
__TOC__
== OrTipTrigger ==
<code>type = "or"</code>
=== 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 ==
<code>type = "and"</code>
=== 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 ==
<code>type = "sequence"</code>
=== triggers ===
'''Type''': [[Types/table]] of [[Types/TipTrigger]]
Array of other tip triggers.
== DependenciesMetTipTrigger ==
<code>type = "dependencies-met"</code>
This tip trigger is considered fulfilled when the dependencies of the [[Prototype/TipsAndTricksItem]] are fulfilled.
== TimeElapsedTipTrigger ==
<code>type = "time-elapsed"</code>
=== ticks ===
'''Type''': [[Types/uint32]]
== ResearchTechnologyTipTrigger ==
<code>type = "research"</code>
=== technology ===
'''Type''': [[Types/string]]
Name of a [[Prototype/Technology]]. Mandatory.
== UnlockRecipeTipTrigger ==
<code>type = "unlock-recipe"</code>
=== recipe ===
'''Type''': [[Types/string]]
Name of a [[Prototype/Recipe]]. Mandatory.
== CraftItemTipTrigger ==
<code>type = "craft-item"</code>
=== 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 <code>event_type</code> "crafting-finished".
=== event_type ===
'''Type''': [[Types/string]]
Mandatory. One of "crafting-of-single-item-ordered", "crafting-of-multiple-items-ordered" or "crafting-finished".
== BuildEntityTipTrigger ==
<code>type = "build-entity"</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.
=== 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 ==
<code>type = "manual-transfer"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
== StackTransferTipTrigger ==
<code>type = "stack-transfer"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
=== transfer ===
'''Type''': [[Types/string]]
'''Default''': any transfer
Optional. One of "stack", "inventory" or "whole-inventory".
== EntityTransferTipTrigger ==
<code>type = "entity-transfer"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
=== transfer ===
'''Type''': [[Types/string]]
'''Default''': any transfer
Optional. One of "in" or "out".
== SetRecipeTipTrigger ==
<code>type = "set-recipe"</code>
=== 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 ==
<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.
== LimitChestTipTrigger ==
<code>type = "limit-chest"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
== UsePipetteTipTrigger ==
<code>type = "use-pipette"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
== SetLogisticRequestTipTrigger ==
<code>type = "set-logistic-request"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
=== logistic_chest_only ===
'''Type''': [[Types/bool]]
'''Default''': false
Optional.
== UseConfirmTipTrigger ==
<code>type = "use-confirm"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
== LowPowerTipTrigger ==
<code>type = "low-power"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''Default''': 1
Optional.
== PasteEntitySettingsTipTrigger ==
<code>type = "paste-entity-settings"</code>
=== 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 ==
<code>type = "fast-replace"</code>
=== 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 ==
<code>type = "group-attack"</code>
=== count ===
'''Type''': [[Types/uint32]]
'''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.

Latest revision as of 14:32, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Types/TipTrigger&oldid=202784"