From ee1a30d7870990c624435c638ca7957a827842ae Mon Sep 17 00:00:00 2001
From: omniraptorr <63944670+omniraptorr@users.noreply.github.com>
Date: Wed, 13 May 2020 23:54:03 -0700
Subject: [PATCH] added get/setgmnotes and field max display lengths

---
 docs/object.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/docs/object.md b/docs/object.md
index 4d5dd30f..6b797625 100644
--- a/docs/object.md
+++ b/docs/object.md
@@ -138,6 +138,7 @@ getAttachments() | Returns a table in the same format as [getObjects()](#getobje
 getCustomObject() | Returns a Table with the Custom Object information of a Custom Object. | [<span class="ret tab"></span>](types.md) | [<span class="i"></span>](#getcustomobject)
 <a class="anchor" id="getdescription"></a>getDescription() | Description, also shows as part of Object's tooltip. | [<span class="ret str"></span>](types.md)
 getFogOfWarReveal() | Settings impacting [Fog of War](https://kb.tabletopsimulator.com/game-tools/zone-tools/#fog-of-war-zone) being revealed. | [<span class="ret tab"></span>](types.md) | [<span class="i"></span>](#getfogofwarreveal)
+<a class="anchor" id="getgmnotes"></a>getGMNotes() | GM Notes, a special text field only shown to color Black. | [<span class="ret str"></span>](types.md)
 <a class="anchor" id="getguid"></a>getGUID() | String of the Object's unique identifier. | [<span class="ret str"></span>](types.md) |
 <a class="anchor" id="getjson"></a>getJSON() | Returns a serialization of the JSON string which represents this item. Works with [spawnObjectJSON()](base.md#spawnobjectjson). | [<span class="ret str"></span>](types.md) |
 getJoints() | Returns information on any joints attached to this object. | [<span class="ret tab"></span>](types.md) | [<span class="i"></span>](#getjoints)
@@ -165,6 +166,7 @@ Function Name | Description | Return | &nbsp;
 setCustomObject([<span class="tag tab"></span>](types.md)&nbsp;parameters) | Sets a custom Object's properties. | [<span class="ret boo"></span>](types.md) | [<span class="i"></span>](#setcustomobject)
 <a class="anchor" id="setdescription"></a>setDescription([<span class="tag str"></span>](types.md)&nbsp;description) | Sets a description for an Object. Shows in tooltip after delay. | [<span class="ret boo"></span>](types.md)
 setFogOfWarReveal([<span class="tag tab"></span>](types.md)&nbsp;fog_settings) | Establish the settings and enable/disable an Object's revealing of [Fog of War](https://kb.tabletopsimulator.com/game-tools/zone-tools/#fog-of-war-zone). | [<span class="ret boo"></span>](types.md) | [<span class="i"></span>](#setfogofwarreveal)
+<a class="anchor" id="setgmnotes"></a>setGMNotes([<span class="tag str"></span>](types.md)&nbsp;gmnotes) | Sets a GM Note on an object. This text field is only shown to color Black. | [<span class="ret boo"></span>](types.md)
 <a class="anchor" id="setlock"></a>setLock([<span class="tag boo"></span>](types.md)&nbsp;lock) | Sets if an object is locked in place. | [<span class="ret boo"></span>](types.md) |
 <a class="anchor" id="setname"></a>setName([<span class="tag str"></span>](types.md)&nbsp;name) | Sets a name for an Object. Shows in tooltip. | [<span class="ret boo"></span>](types.md)
 setRotationValues([<span class="tag tab"></span>](types.md)&nbsp;rotation_values) | Sets rotation values of an object. Rotation values are used to give value to different rotations (like dice). | [<span class="ret boo"></span>](types.md) | [<span class="i"></span>](#setrotationvalues)
@@ -172,7 +174,8 @@ setRotationValues([<span class="tag tab"></span>](types.md)&nbsp;rotation_values
 setValue([<span class="tag var"></span>](types.md)&nbsp;value) | Sets an Int as the value. What the value represents depends on what type of Object it is. | [<span class="ret boo"></span>](types.md) | [<span class="i"></span>](#setvalue)
 
 
-
+!!! info "Text Property Display Lengths"
+    While you can store any length of string with the functions `setName()`, `setDescription()`, and `setGMNotes()` (and retrieve them later with the corresponding getter function), the in-game UI will only show the first 255, 2048, and 400 characters of each field respectively.
 
 
 ###Action Function