Update scripting reference (SuperTux/supertux@50743fb)

SuperTux · Jan 7, 2024 · 6527038 · 6527038
1 parent 532e097
commit 6527038
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/ScriptingTextArray.md → ScriptingTextArrayObject.md b/ScriptingTextArray.md → ScriptingTextArrayObject.md
@@ -3,12 +3,16 @@
 Summary
 -------
 
-A `TextArrayObject` that was given a name can be controlled by scripts.
+A `TextArrayObject` that was given a name (or manually instantiated) can be controlled by scripts.
 
 Instance
 --------
 
-A `TextArrayObject` is instantiated by placing a definition inside a level. It can then be accessed by its name from a script or via `sector.name` from the console. 
+A `TextArrayObject` instance is already provided in sectors under `sector.TextArray`.
+
+A `TextArrayObject` can also be created in a script or from the console. Constructor:
+
+```<textarrayobj> <- TextArrayObject()``` 
 
 Methods
 -------

diff --git a/ScriptingText.md → ScriptingTextObject.md b/ScriptingText.md → ScriptingTextObject.md
@@ -3,12 +3,16 @@
 Summary
 -------
 
-A `TextObject` that was given a name can be controlled by scripts.
+A `TextObject` that was given a name (or manually instantiated) can be controlled by scripts.
 
 Instance
 --------
 
-A `TextObject` is instantiated by placing a definition inside a level. It can then be accessed by its name from a script or via `sector.name` from the console. 
+A `TextObject` instance is already provided in sectors under `sector.Text`.
+
+A `TextObject` can also be created in a script or from the console. Constructor:
+
+```<textobj> <- TextObject()``` 
 
 Methods
 -------
@@ -29,6 +33,8 @@ Method | Explanation
 `set_anchor_point(int anchor)` | Sets the anchor point of the text. <br /><br /> `anchor` - One of the `ANCHOR_*` constants (see [AnchorPoints](https://github.com/SuperTux/supertux/wiki/ScriptingAnchorPoints)). 
 `get_anchor_point()` | Returns the current anchor point of the text (one of the `ANCHOR_*` constants; see [AnchorPoints](https://github.com/SuperTux/supertux/wiki/ScriptingAnchorPoints)). 
 `set_anchor_offset(float x, float y)` | Sets the anchor offset of the text. 
+`get_wrap_width()` | Gets the text wrap width of the text. 
+`set_wrap_width(float width)` | Sets the text wrap width of the text. 
 `set_front_fill_color(float red, float green, float blue, float alpha)` | Sets the front fill color of the text. 
 `set_back_fill_color(float red, float green, float blue, float alpha)` | Sets the back fill color of the text. 
 `set_text_color(float red, float green, float blue, float alpha)` | Sets the text color. 

diff --git a/Scripting_Reference.md b/Scripting_Reference.md
@@ -91,8 +91,8 @@ using a function that actually doesn't exist.
 * [Sector](https://github.com/SuperTux/supertux/wiki/ScriptingSector)
 * [SoundObject](https://github.com/SuperTux/supertux/wiki/ScriptingSoundObject)
 * [Spotlight](https://github.com/SuperTux/supertux/wiki/ScriptingSpotlight)
-* [Text](https://github.com/SuperTux/supertux/wiki/ScriptingText)
-* [TextArray](https://github.com/SuperTux/supertux/wiki/ScriptingTextArray)
+* [TextArrayObject](https://github.com/SuperTux/supertux/wiki/ScriptingTextArrayObject)
+* [TextObject](https://github.com/SuperTux/supertux/wiki/ScriptingTextObject)
 * [Thunderstorm](https://github.com/SuperTux/supertux/wiki/ScriptingThunderstorm)
 * [TileMap](https://github.com/SuperTux/supertux/wiki/ScriptingTileMap)
 * [Torch](https://github.com/SuperTux/supertux/wiki/ScriptingTorch)