# HG changeset patch
# User Wuzzy
# Date 1460186566 -3600
# Node ID ed6a7ad2770f071202fa2c77de9385a1d8c9c119
# Parent  a442063fcf2ef8106d4ee499200697c925c37be3
LuaAPI: PlaceSprite return value

diff -r a442063fcf2e -r ed6a7ad2770f LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Apr 07 19:52:48 2016 +0100
+++ b/LuaAPI.wiki	Sat Apr 09 08:22:46 2016 +0100
@@ -938,7 +938,8 @@
 || 7 || long || increasing right ||
 
 ==== <tt>!PlaceSprite(x, y, sprite, frameIdx, tint, behind, flipHoriz, flipVert, [, landFlag, ...])</tt> ====
-Places a [Sprites sprite] at the specified position (`x`, `y`) on the map, it behaves like terrain then. `frameIdx` is the frame index starting by 0. This is used if the sprite consists of several sub-images. Only a subset of the sprites is currently supported by this function:
+Places a [Sprites sprite] at the specified position (`x`, `y`) on the map, it behaves like terrain then. `frameIdx` is the frame index starting by 0. The placement may fail, for example if the sprite goes too far out of the land boundaries. The function returns `true` if the placement was successful, `false` otherwise.
+`frameIdx` is used if the sprite consists of several sub-images. Only a subset of the sprites is currently supported by this function:
 
  * `sprAmGirder`
  * `sprAmRubber`