Differences

This shows you the differences between two versions of the page.

--- 4rpl:commands:getbuildunit [2021/03/08 20:13] – created virgilw
+++ 4rpl:commands:getbuildunit [2022/09/10 16:46] – [Description] Type fixed for the 3rd time (better description) Vertu
@@ Line 2: / Line 2: @@
 <=[[4rpl:start| Index]]
-:!: Available in version 1.X and later.
+:!: Available in version 1.4 and later.
 ====== GetBuildUnit ======
 GetBuildUnit ->selectBuildUnit
 ===== Description =====
-When building a unit, returns the string for the unit's type. For custom units, the string is the CMOD GUID. For built in units it is the unit name. If no unit is being built, an empty string is returned.
+Returns the [[4rpl:commands:unit_types|unit type]] of the unit currently selected in the build menu. For custom units, the string is the CMOD GUID. For built in units it is the built-in [[4rpl:commands:unit_types|unit type]]. If no unit is selected in the build menu, an empty string is returned.
+Example: When the player selects the Cannon from the weapons build tab, "Cannon" will be returned by this API.
 ===== Examples =====
 <code 4rpl>

Knuckle Cracker Wiki