# HG changeset patch
# User Wuzzy
# Date 1534882157 -3600
# Node ID 18582093d89439bece19c00c0a571b5d6158b183
# Parent 06e3cd099d4b9303908bc409ee0d088912c17415
LuaAPI: Update GetVisualGearType and GetGearType
diff -r 06e3cd099d4b -r 18582093d894 LuaAPI.wiki
--- a/LuaAPI.wiki Tue Aug 21 21:04:40 2018 +0100
+++ b/LuaAPI.wiki Tue Aug 21 21:09:17 2018 +0100
@@ -472,10 +472,10 @@
== Functions to get gear properties ==
=== !GetGearType(gearUid) ===
-This function returns the [GearTypes gear type] for the specified gear.
+This function returns the [GearTypes gear type] for the specified gear, if it exists. If it doesn't exist, `nil` is returned.
=== !GetVisualGearType(vgUid) (0.9.23) ===
-This function returns the [VisualGearTypes visual gear type] for the specified visual gear.
+This function returns the [VisualGearTypes visual gear type] for the specified visual gear, if it exists. If it doesn't exist, `nil` is returned.
=== !GetGearPosition(gearUid) ===
Returns x,y coordinates for the specified gear. Not to be confused with `GetGearPos`.
@@ -679,7 +679,7 @@
HideHog(gear) -- Hide the newly created gear.
=== !RestoreHog(gearUid) ===
-Restores a previously hidden hedgehog.
+Restores a previously hidden hedgehog. Nothing happens if the hedgehog does not exist or is not hidden.
Example:
@@ -688,7 +688,7 @@
RestoreHog(gear) -- Restore the newly hidden gear.
=== !DeleteGear(gearUid) ===
-Deletes a gear.
+Deletes a gear. If the specified gear did not exist, nothing happens.
Example:
@@ -696,7 +696,11 @@
DeleteGear(gear) -- Delete the newly created gear.
=== !DeleteVisualGear(vgUid) ===
-Deletes a visual gear. Note, most visual gears delete themselves.
+Deletes a visual gear. If it does not exist, nothing happens.
+
+Note, most visual gears delete themselves after a while.
+
+
Example: