Instructions/Set to Component: Difference between revisions

Set to Component
Lua ID	set_comp_reg
Category	Math
Icon	Set Component Reg.png
Argument One: Type	Input
Argument One: Name	Value
Argument One: Description	Value to set
Argument One: Data Type	any
Argument Two: Type	Input
Argument Two: Name	To
Argument Two: Description	Component and register number to set
Argument Two: Data Type	comp_num
Argument Three: Type	Input
Argument Three: Name	Component Index
Argument Three: Description	Component index if multiple are equipped
Argument Three: Data Type	num

VisualWikitext

Latest revision as of 03:36, 2 January 2024

Description[edit | edit source]

Used to set a value to a component register with a specified index.

Uses[edit | edit source]

Can typically be used to set a Turret, Repair Component, Deconstructor or Miner to a specific target, but for Radar, it is probably advisable to use the Radar instruction instead. Can also be used to set the production recipe for factory buildings.

Indexes 0 and 1 are both treated as index 1.

A component seldom has multiple input registers, but for the few that exist, any number from 1 - n can be used to specify what index to write data to.

In its most dynamic usage, it can be used to write directly to the parameters from another Behavior Controller, which can have a theoretically infinite amount of parameters.

The third argument (Group/Index) specifies the 1-based index of the component to set from the list of components when filtered by the Component/Index argument.

Take for a building with the components below:

In this example setting Component/Index to an Assembler the possible values for Group/Index are only 1. If you set Component/Index to Fabricator the possible values for Group/Index are also only 1 as there is only one Fabricator slotted in this building.

Similar Instructions[edit | edit source]

Get from Component, Radar, Mine

Instructions
Unit	Check Altitude:Check Battery:Check Blightness:Check Grid Efficiency:Check Health:Clear All Links:Clear Link:Connect:Count Items:Count Slots:Disable Transport Route:Disconnect:Drop Off Items:Enable Transport Route:Equip Component:First Item:Fix Item Slots:Get Active Order:Get Closest Entity:Get Closest Unit:Get First Locked Id:Get Inventory Item:Get Item Info:Get Unit Info:Get Unit Power Info:Get Unit Type:Inventory Total:Is Docked:Is Equipped:Is Fixed:Is Inside Logistics Network:Is Moving:Is Same Grid:Is Unit A:Lock Itemslot:Loop Nearby Resources:Match:Order to Shared Storage:Order Transfer To:Package All:Pick Up Items:Read Radio:Read Signal:Request Item:Request Wait:Set Link:Solve Explorable:Sort Storage:Switch:Turn Off:Turn On:Unequip Component:Unfix Item Slots:Unlock Itemslot:Unpackage All
Move	Move Unit (Range):Attack Move:Is Passable:Move Away (Range):Move East:Move North:Move South:Move Unit:Move Unit (Async)*:Move West:Scout:Scout Range:Stop Unit
Component	Deploys held unit:Mine:Radar:Set Signpost
Flow	Loop Signal:Break:call:Call:Clear Research:Compare Entity:Compare Item:Compare Register:Compare Unit:Data type switch:Exit:Get Max Stack:Get Research:Get Research Requirement:Have Item:Is a:Is Empty:Is Unlocked:Jump:Label:Lock:Loop Components:Loop Entities (Range):Loop Inventory Slots:Loop Number:Loop Producers:Loop Recipe Ingredients:Loop Research:Loop Research Ingredients:Loop Research Unlocks:Loop Signal (Match):Loop Units (Range):Restart:Select Nearest:Set Research:Unit Type:Unlock:Wait Ticks
Math	Add:Check space for item:Combine Coordinate:Combine Register:Compare Number:Copy:Divide:Get Battery:Get Entity At:Get Equipped Num:Get from Component:Get Grid Efficiency:Get Health:Get Resource Num:Get Self:Get Shield:Get space for item:Get Unit At:Is Working:Modulo:Multiply:Random Coordinate:Random Number:Separate Coordinate:Separate Register:Set Number:Set to Component:Subtract
Global	Abort Construction:Can Produce:DebugPrint:Distance:Faction Item Amount:Get Home:Get Ingredients:Get Location:Get Season:Get Stability:Get Trust:Get Type:Is Day/Night:Land:Launch:Lookat:Notify:Percent:Pings a Unit:Place Construction:Produce Registered Unit:Produce Unit:Read Key:Remap:Resource Type

@@ Line 6: / Line 6: @@
 ==== Uses ====
-Can typically be used to set a Turret, Repair Component, Deconstructor or Miner to a specific target, but for Radar, it is probably advisable to use the [[Instructions/Radar|Radar]] instruction instead.
+Can typically be used to set a Turret, Repair Component, Deconstructor or Miner to a specific target, but for Radar, it is probably advisable to use the [[Instructions/Radar|Radar]] instruction instead. Can also be used to set the production recipe for factory buildings.
-and 1 are both treated as index 1.
+Indexes 0 and 1 are both treated as index 1.
 A component seldom has multiple input registers, but for the few that exist, any number from 1 - n can be used to specify what index to write data to.
@@ Line 15: / Line 15: @@
 In its most dynamic usage, it can be used to write directly to the parameters from another Behavior Controller, which can have a theoretically infinite amount of parameters.
+The third argument (Group/Index) specifies the 1-based index of the component to set from the list of components when filtered by the Component/Index argument.
+Take for a building with the components below:
+[[File:Set to component group example.png]]
+In this example setting Component/Index to an Assembler the possible values for Group/Index are only 1. If you set Component/Index to Fabricator the possible values for Group/Index are also only 1 as there is only one Fabricator slotted in this building.
 ==== Similar Instructions ====