Differences

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

--- set_vision_height [2017/05/14 15:31] – external edit 127.0.0.1
+++ set_vision_height [2021/04/21 18:52] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Changes the vision height (in voxel units) of the specified entity.
+Changes the vision height (in [[voxel|voxels]]) of the specified [[character]]. This value determines the camera placement (i.e. the height above the [[tile]] on which the player is standing) while in first-person view. Vision height is also used when adjusting the camera to "look at" a particular [[character]].
+====Signature:====
 <code python>
-set_vision_height(player, 12)
+set_vision_height(character, height)
 </code>
 ^Argument^Description^Type^Required^
-|player|Description.|[[String]]|Yes|
+|character|[[Character]] for which to update the vision height.|[[Entity]]|Yes|
-| 12|Description.|[[String]]|Yes|
+|height|Height of the [[character|character's]] vision (in [[voxel|voxels]]).|[[Number]]|Yes|
 ====Example:====
-<code python>
+<code bauxite>
-set_vision_height(player, 12)
+set_vision_height(player, 6);
 </code>
-//Results://
+//Results:// The player's vision height is changed to a height of 6 [[voxel|voxels]].
 <WRAP center round tip 100%>
-Use the **Set Vision Height** function to ...
+Use the **Set Vision Height** function to give the appearance of the player growing older over time or to create the illusion that the player has shrunk after drinking a potion.
 </WRAP>

RPG in a BoxOfficial Documentation