Instructions/Get from Component: Difference between revisions

Get from Component

     Reads a value from a component register


Lua ID	get_comp_reg
Category	Math
Icon	Set Component Reg.png
Argument One: Type	Input
Argument One: Name	From
Argument One: Description	Component and register number to get
Argument One: Data Type	comp_num
Argument Two: Type	Output
Argument Two: Name	Value
Argument Two: Description	Value of Register
Argument Three: Type	Input
Argument Three: Name	Component Index
Argument Three: Description	Component index if multiple are equipped
Argument Three: Data Type	num

Description

Uses

Can typically be used to get the target of a Turret, Repair Component, Deconstructor or Miner.

0 and 1 are both treated as index 1.

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

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

Similar Instructions

Set to Component

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 5: / Line 5: @@
 ==== Uses ====
+Can typically be used to get the target of a Turret, Repair Component, Deconstructor or Miner.
+and 1 are both treated as index 1.
+A component seldom has multiple registers, but for the few that exist, any number from 1 - n can be used to specify what index to read data from.
+In its most dynamic usage, it can be used to read directly from the parameters of another Behavior Controller, which can have a theoretically infinite amount of parameters.
 ==== Similar Instructions ====
+[[Instructions/Set to Component|Set to Component]]
 {{Instruction_Bottom}}

Revision as of 05:17, 17 September 2023

Description

Uses

Similar Instructions