Instructions: Difference between revisions

From Desynced Wiki

Revision as of 16:52, 25 August 2023

An instruction is a node within behavior programming. Each instruction is composed of .LUA code.

List of Instructions and how they can be used [Community Member added - May not be accurate or contain all possible use cases] -- WIP

Unit

Move

Component

Flow

Math

Compare Number

Comparing a variable against the value of 100. This allows for the node to be used as a conditional statement.

The "Compare Number" Component takes in a value and compares that value against another. This can be used to compare two numbers as intended or used as an if statement. To use this node as an if statement you can compare a value of 0/1 against 0 this will allow you to use the "If Larger" and "If Smaller" as true or false to determine a conditional statement.

Global

Distance

The "Distance" component takes a location based input (unit world location) and stores the distance from the that input to the unit your script is being run on in the result. This can be used identify how far one unit is away from another.

Get Home

Writing the Home value to the Signal Register

The "Get Home" component gets the factions Home Unit and writes the result to a Unit Register or a Variable. The result can then be referenced later as the home location.

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

Retrieved from "https://wiki.desyncedgame.com/index.php?title=Instructions&oldid=7574"

@@ Line 1: / Line 1: @@
-An instruction is a node within behaviour programming. Each instruction is composed of .LUA code.
+An instruction is a node within behavior programming. Each instruction is composed of .LUA code.
+<blockquote>List of Instructions and how they can be used [Community Member added - May not be accurate or contain all possible use cases] -- WIP</blockquote>
+= Unit =
+= Move =
+= Component =
+= Flow =
+= Math =
+====== Compare Number ======
+[[File:Compare Number Node.png|thumb|Comparing a variable against the value of 100. This allows for the node to be used as a conditional statement.]]
+The "Compare Number" Component takes in a value and compares that value against another. This can be used to compare two numbers as intended or used as an if statement. To use this node as an if statement you can compare a value of 0/1 against 0 this will allow you to use the "If Larger" and "If Smaller" as true or false to determine a conditional statement.
+= Global =
+====== Distance ======
+[[File:Distance Node.png|thumb|Using the signal register as an input (which is set to a unit world location) and storing the distance value as a variable.]]
+The "Distance" component takes a location based input (unit world location) and stores the distance from the that input to the unit your script is being run on in the result. This can be used identify how far one unit is away from another.
+====== Get Home ======
+[[File:GetHome.png|thumb|Writing the Home value to the Signal Register]]
+The "Get Home" component gets the factions Home Unit and writes the result to a Unit Register or a Variable. The result can then be referenced later as the home location.
-"Just write the guide"
 {{InstructionsNav}}