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. | [](types.md) | [](#getcustomobject) getDescription() | Description, also shows as part of Object's tooltip. | [](types.md) getFogOfWarReveal() | Settings impacting [Fog of War](https://kb.tabletopsimulator.com/game-tools/zone-tools/#fog-of-war-zone) being revealed. | [](types.md) | [](#getfogofwarreveal) +getGMNotes() | GM Notes, a special text field only shown to color Black. | [](types.md) getGUID() | String of the Object's unique identifier. | [](types.md) | getJSON() | Returns a serialization of the JSON string which represents this item. Works with [spawnObjectJSON()](base.md#spawnobjectjson). | [](types.md) | getJoints() | Returns information on any joints attached to this object. | [](types.md) | [](#getjoints) @@ -165,6 +166,7 @@ Function Name | Description | Return |   setCustomObject([](types.md) parameters) | Sets a custom Object's properties. | [](types.md) | [](#setcustomobject) setDescription([](types.md) description) | Sets a description for an Object. Shows in tooltip after delay. | [](types.md) setFogOfWarReveal([](types.md) 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). | [](types.md) | [](#setfogofwarreveal) +setGMNotes([](types.md) gmnotes) | Sets a GM Note on an object. This text field is only shown to color Black. | [](types.md) setLock([](types.md) lock) | Sets if an object is locked in place. | [](types.md) | setName([](types.md) name) | Sets a name for an Object. Shows in tooltip. | [](types.md) setRotationValues([](types.md) rotation_values) | Sets rotation values of an object. Rotation values are used to give value to different rotations (like dice). | [](types.md) | [](#setrotationvalues) @@ -172,7 +174,8 @@ setRotationValues([](types.md) rotation_values setValue([](types.md) value) | Sets an Int as the value. What the value represents depends on what type of Object it is. | [](types.md) | [](#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