Differences

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

--- prpl:getshipfromslot [2017/03/30 06:21] – specified the error return values kajacx
+++ prpl:getshipfromslot [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 8: / Line 8: @@
 === Description ===
-int ARG1: Slot ID. Valid slot IDs are 0 to 23 inclusive.
+Returns the Ship ID for any built ship associated with a given build slot. Valid slot IDs are 0 to 23 inclusive. (Note: -1 may be the HQ slot.) -1 is returned if the ship is not placed (an unconstructed build outline counts) or if the slot ID is invalid. -2 is returned when there is no ship build button at the given slot.
-Returns the Ship UID for any built ship associated with a given build slot. -1 is returned if the ship is not build (just having the CM placed counts as being build) or if the slot ID is invalid. -2 is returned when there is no ship build button at the given slot.
 === Examples ===
-<code>TODO
+<code prpl>
-</code>
+CreateList ->PlayerFleet
+-1 do
+    I GetShipFromSlot ->Ship
+    <-Ship 0 gte if
+        <-PlayerFleet <-Ship AppendToList
+    endif
+loop
+#Congratulations, we now have a list of the player-controlled ships. Not blue or red ships, however.
+</code>

Knuckle Cracker Wiki