New compatibility version 1.103

Renamed TextRender to Text3D
New TextRender entity

Author: gtnardy

docs/core-concepts/packages/compatibility-versions.md

@@ -36,6 +36,16 @@ The Compatibility Mode is a feature that aims to keep old and unmaintained packa
 To use the following features, you must update your Package's `compatibility_version` setting in the Package.toml to at least that version (exact that version or bigger).
 
 
+### Version `1.103`
+
+
+#### [TextRender](/scripting-reference/classes/text-render.mdx)
+
+`TextRender` was renamed to [Text3D](/scripting-reference/classes/text-3d.mdx). And a new entity `TextRender` was created. To use the new TextRender entity, you must update your `compatibility_version` to at least `1.103`.
+
+In compatibility mode (i.e. setting it to `1.102` or below) `TextRender` will still point to the old `TextRender` class (i.e. to the new `Text3D` class).
+
+
 ### Version `1.65`
 
 

docs/getting-started/tutorials-and-examples/name-tags.md

@@ -22,12 +22,9 @@ function AddNametag(player, character)
     -- Spawns the Nametag (TextRender),
     local nametag = TextRender(
         Vector(),               -- Any Location
-        Rotator(),              -- Any Rotation
         player:GetName(),       -- Player Name
-        Vector(0.5, 0.5, 0.5),  -- 50% Scale
-        Color(1, 1, 1),         -- White
-        FontType.Roboto,        -- Roboto Font
-        TextRenderAlignCamera.AlignCameraRotation -- Follow Camera Rotation
+        30,                     -- Text Size
+        Color.WHITE         	-- White Color
     )
 
     -- Attaches it to the character and saves it to the player's values

docs/scripting-reference/classes/text-3d.mdx

@@ -0,0 +1,59 @@
+---
+title: 🆒 Text3D
+description: Class to create 3D Text with advanced options
+sidebar_position: 0
+tags: [class]
+---
+
+<HeaderDeclaration type="Class" name="Text3D" image="/img/docs/text-3d.webp" />
+
+:::warning
+
+**Text3D** is experimental and may have some limitations. It generates meshes dynamically in runtime, thus it is more performance heavy. Consider using <Classes.TextRender /> if you don't need the extra features.
+
+:::
+
+
+## 🎒 Examples
+
+```lua showLineNumbers
+local my_text_3d = Text3D(
+    Vector(-100, 200, 300),
+    Rotator(),
+    "My Awesome Text",
+    Vector(1, 1, 1), -- Scale
+    Color(1, 0, 0), -- Red Color
+    FontType.OpenSans,
+    Text3DAlignCamera.FaceCamera
+)
+```
+
+:::info
+
+If you desire your **Text3D** to be visible through walls, replace it's material with the nanos Default TranslucentDepth one!
+
+`SetMaterial("nanos-world::M_Default_Translucent_Unlit_Depth")`.
+
+You can also tweak it's color and other properties using the Material methods.
+
+:::
+
+
+## 🛠 Constructors
+
+<ConstructorDeclaration type="Class" name="Text3D" />
+
+
+## 🗿 Static Functions
+
+<StaticFunctionsDeclaration type="Class" name="Text3D" />
+
+
+## 🦠 Functions
+
+<FunctionsDeclaration type="Class" name="Text3D" />
+
+
+## 🚀 Events
+
+<EventsDeclaration type="Class" name="Text3D" />

docs/scripting-reference/classes/text-render.mdx

@@ -15,23 +15,11 @@ local my_text_render = TextRender(
     Vector(-100, 200, 300),
     Rotator(),
     "My Awesome Text",
-    Vector(1, 1, 1), -- Scale
-    Color(1, 0, 0), -- Red Color
-    FontType.OpenSans,
-    TextRenderAlignCamera.FaceCamera
+    40, -- Text Size
+    Color.RED
 )
 ```
 
-:::info
-
-If you desire your **TextRender** to be visible through walls, replace it's material with the nanos Default TranslucentDepth one!
-
-`SetMaterial("nanos-world::M_Default_Translucent_Unlit_Depth")`.
-
-You can also tweak it's color and other properties using the Material methods.
-
-:::
-
 <ReferenceLink href="getting-started/tutorials-and-examples/name-tags">Nametags</ReferenceLink>
 
 

src/api

@@ -27,6 +27,7 @@ import SceneCaptureData from '@site/src/api/.generated/Classes/SceneCapture.json
 import StaticMeshData from '@site/src/api/.generated/Classes/StaticMesh.json';
 import SoundData from '@site/src/api/.generated/Classes/Sound.json';
 import TextRenderData from '@site/src/api/.generated/Classes/TextRender.json';
+import Text3DData from '@site/src/api/.generated/Classes/Text3D.json';
 import TriggerData from '@site/src/api/.generated/Classes/Trigger.json';
 import VehicleWheeledData from '@site/src/api/.generated/Classes/VehicleWheeled.json';
 import VehicleWaterData from '@site/src/api/.generated/Classes/VehicleWater.json';
@@ -104,6 +105,7 @@ import SceneCaptureDataStable from '@site/src/api/.generated/Stable/Classes/Scen
 import StaticMeshDataStable from '@site/src/api/.generated/Stable/Classes/StaticMesh.json';
 import SoundDataStable from '@site/src/api/.generated/Stable/Classes/Sound.json';
 import TextRenderDataStable from '@site/src/api/.generated/Stable/Classes/TextRender.json';
+import Text3DDataStable from '@site/src/api/.generated/Stable/Classes/Text3D.json';
 import TriggerDataStable from '@site/src/api/.generated/Stable/Classes/Trigger.json';
 import VehicleWheeledDataStable from '@site/src/api/.generated/Stable/Classes/VehicleWheeled.json';
 import VehicleWaterDataStable from '@site/src/api/.generated/Stable/Classes/VehicleWater.json';
@@ -181,6 +183,7 @@ const APIData = {
 			SceneCapture: SceneCaptureDataStable,
 			StaticMesh: StaticMeshDataStable,
 			Sound: SoundDataStable,
+			Text3D: Text3DDataStable,
 			TextRender: TextRenderDataStable,
 			Trigger: TriggerDataStable,
 			VehicleWheeled: VehicleWheeledDataStable,
@@ -261,6 +264,7 @@ const APIData = {
 			SceneCapture: SceneCaptureData,
 			StaticMesh: StaticMeshData,
 			Sound: SoundData,
+			Text3D: Text3DData,
 			TextRender: TextRenderData,
 			Trigger: TriggerData,
 			VehicleWheeled: VehicleWheeledData,

src/components/APIData.jsx

@@ -232,6 +232,7 @@ export const Classes = {
 	SceneCapture: () => BaseClass("SceneCapture", "📽️", "SceneCapture", "scene-capture"),
 	Sound: () => BaseClass("Sound", "🔊"),
 	StaticMesh: () => BaseClass("StaticMesh", "🏠", "StaticMesh", "static-mesh"),
+	Text3D: () => BaseClass("Text3D", "🆒", "Text3D", "text-3d"),
 	TextRender: () => BaseClass("TextRender", "🆒", "TextRender", "text-render"),
 	Trigger: () => BaseClass("Trigger", "🪤"),
 	VehicleWheeled: () => BaseClass("VehicleWheeled", "🚙", "VehicleWheeled", "vehicle-wheeled"),

src/components/_nanos.jsx

@@ -568,8 +568,8 @@
           "title": "🔤 3D Text Entity",
           "image": "/roadmap/3dtext.webp",
           "description": "This entity allows for the creation of 3D text rendered within the game world.",
-          "external_link": "/docs/next/scripting-reference/classes/text-render",
-          "external_link_title": "TextRender",
+          "external_link": "/docs/next/scripting-reference/classes/text-3d",
+          "external_link_title": "Text3D",
           "labels": ["released", "scripting"]
         },
         {