S T

2025-12-29 16:02:05 +01:00
parent 10e4551174
commit 9ced84e77d
13 changed files with 55 additions and 55 deletions
--- a/xml/types/Script.xml
+++ b/xml/types/Script.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>false</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The source code of the script as a string.</Description>
  </Properties>
  <Properties>
    <Name>LinkedScript</Name>
@@ -16,7 +16,7 @@
    <IsAccessibleByScripts>false</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>A linked script asset associated with this script.</Description>
  </Properties>
  <Properties>
    <Name>Compatibility</Name>
@@ -24,7 +24,7 @@
    <IsAccessibleByScripts>false</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Indicates whether the script is running in compatibility mode.</Description>
  </Properties>
  <Methods>
    <Name>Call</Name>
@@ -44,7 +44,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Calls a function in the script with the given arguments.</Description>
  </Methods>
  <Methods>
    <Name>CallAsync</Name>
@@ -64,10 +64,10 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Calls a function in the script asynchronously with the given arguments.</Description>
  </Methods>
  <IsStatic>false</IsStatic>
  <IsAbstract>true</IsAbstract>
  <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Scripts are abstract base classes representing Lua code that can be executed in the game.</Description>
 </ClassDef>
--- a/xml/types/ScriptService.xml
+++ b/xml/types/ScriptService.xml
@@ -5,5 +5,5 @@
  <IsStatic>true</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>ScriptService is a service used for storing scripts and local scripts. It is also responsible for managing their execution within the game.</Description>
 </ClassDef>
--- a/xml/types/Seat.xml
+++ b/xml/types/Seat.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Indicates who is currently occupying the seat.</Description>
  </Properties>
  <Properties>
    <Name>CanNPCSit</Name>
@@ -16,7 +16,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether NPCs are allowed to sit on this seat or only players.</Description>
  </Properties>
  <Events>
    <Name>Sat</Name>
@@ -24,7 +24,7 @@
      <Name>occupant</Name>
      <Type>NPC</Type>
    </Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when an occupant sits on the seat.</Description>
  </Events>
  <Events>
    <Name>Vacated</Name>
@@ -32,10 +32,10 @@
      <Name>occupant</Name>
      <Type>NPC</Type>
    </Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when an occupant leaves the seat.</Description>
  </Events>
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Seats are parts the player can sit on.</Description>
 </ClassDef>
--- a/xml/types/ServerHidden.xml
+++ b/xml/types/ServerHidden.xml
@@ -5,5 +5,5 @@
  <IsStatic>true</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>ServerHidden, similar to Hidden, is a container for objects that are meant to be hidden. Unlike Hidden, ServerHidden won't replicate its contents to clients and can only be accessed by the server.</Description>
 </ClassDef>
--- a/xml/types/ServerScript.xml
+++ b/xml/types/ServerScript.xml
@@ -5,5 +5,5 @@
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>ServerScript is a script that runs on the server.</Description>
 </ClassDef>
--- a/xml/types/Sky.xml
+++ b/xml/types/Sky.xml
@@ -5,5 +5,5 @@
  <IsStatic>false</IsStatic>
  <IsAbstract>true</IsAbstract>
  <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Sky is an abstract base class representing the sky in the game world.</Description>
 </ClassDef>
--- a/xml/types/Sound.xml
+++ b/xml/types/Sound.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The audio asset to be played by the sound.</Description>
  </Properties>
  <Properties>
    <Name>Volume</Name>
@@ -16,7 +16,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The volume level of the sound.</Description>
  </Properties>
  <Properties>
    <Name>Pitch</Name>
@@ -24,7 +24,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The pitch level of the sound.</Description>
  </Properties>
  <Properties>
    <Name>Autoplay</Name>
@@ -32,7 +32,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the sound should start playing automatically when loaded.</Description>
  </Properties>
  <Properties>
    <Name>Loop</Name>
@@ -40,7 +40,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the sound should loop when it reaches the end.</Description>
  </Properties>
  <Properties>
    <Name>PlayInWorld</Name>
@@ -48,7 +48,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the sound should be played in the 3D world space.</Description>
  </Properties>
  <Properties>
    <Name>MaxDistance</Name>
@@ -56,7 +56,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The maximum distance at which the sound can be heard.</Description>
  </Properties>
  <Properties>
    <Name>Time</Name>
@@ -64,7 +64,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Indicates the current playback position of the sound in seconds.</Description>
  </Properties>
  <Properties>
    <Name>Playing</Name>
@@ -72,7 +72,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>true</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Indicates whether the sound is currently playing.</Description>
  </Properties>
  <Properties>
    <Name>Loading</Name>
@@ -80,7 +80,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>true</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Indicates whether the sound is currently loading.</Description>
  </Properties>
  <Properties>
    <Name>Length</Name>
@@ -88,7 +88,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>true</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The total length of the sound in seconds.</Description>
  </Properties>
  <Methods>
    <Name>Play</Name>
@@ -96,7 +96,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Starts playing the sound.</Description>
  </Methods>
  <Methods>
    <Name>PlayOneShot</Name>
@@ -110,7 +110,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Plays the sound once at the specified volume without affecting the current playback.</Description>
  </Methods>
  <Methods>
    <Name>Stop</Name>
@@ -118,7 +118,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Stops the sound if it is currently playing.</Description>
  </Methods>
  <Events>
    <Name>Loaded</Name>
@@ -128,5 +128,5 @@
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Sounds are objects that can be placed in the world and play audio.</Description>
 </ClassDef>
--- a/xml/types/SpotLight.xml
+++ b/xml/types/SpotLight.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The maximum distance the light can reach.</Description>
  </Properties>
  <Properties>
    <Name>Angle</Name>
@@ -16,10 +16,10 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The angle of the spotlight's cone.</Description>
  </Properties>
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>SpotLight is a source of light emitting in a specific direction and angle that can be placed in the world.</Description>
 </ClassDef>
--- a/xml/types/StringValue.xml
+++ b/xml/types/StringValue.xml
@@ -8,10 +8,10 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The value of this object.</Description>
  </Properties>
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>StringValue is an object that holds a string value.</Description>
 </ClassDef>
--- a/xml/types/SunLight.xml
+++ b/xml/types/SunLight.xml
@@ -5,5 +5,5 @@
  <IsStatic>true</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>SunLight is the main directional light source representing the sun in the game world.</Description>
 </ClassDef>
--- a/xml/types/Text3D.xml
+++ b/xml/types/Text3D.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The text content displayed.</Description>
  </Properties>
  <Properties>
    <Name>FontSize</Name>
@@ -16,7 +16,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The size of the font used for the text.</Description>
  </Properties>
  <Properties>
    <Name>Color</Name>
@@ -24,7 +24,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The color of the text.</Description>
  </Properties>
  <Properties>
    <Name>OutlineWidth</Name>
@@ -32,7 +32,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The width of the text outline.</Description>
  </Properties>
  <Properties>
    <Name>OutlineColor</Name>
@@ -40,7 +40,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The color of the text outline.</Description>
  </Properties>
  <Properties>
    <Name>FaceCamera</Name>
@@ -48,7 +48,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the text should always be facing the camera.</Description>
  </Properties>
  <Properties>
    <Name>HorizontalAlignment</Name>
@@ -56,7 +56,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines the horizontal alignment of the text.</Description>
  </Properties>
  <Properties>
    <Name>VerticalAlignment</Name>
@@ -64,7 +64,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines the vertical alignment of the text.</Description>
  </Properties>
  <Properties>
    <Name>FontAsset</Name>
@@ -72,7 +72,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The font asset used for the text.</Description>
  </Properties>
  <Properties>
    <Name>UseRichText</Name>
@@ -80,10 +80,10 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the text should be parsed as rich text.</Description>
  </Properties>
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Text3D is a class that represents 3D text in the game world.</Description>
 </ClassDef>
--- a/xml/types/Tool.xml
+++ b/xml/types/Tool.xml
@@ -8,7 +8,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines whether the tool can be dropped by the player.</Description>
  </Properties>
  <Properties>
    <Name>Holder</Name>
@@ -16,7 +16,7 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determines who is currently holding this tool.</Description>
  </Properties>
  <Methods>
    <Name>Activate</Name>
@@ -24,7 +24,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Activates the tool, similarly to pressing the mouse button.</Description>
  </Methods>
  <Methods>
    <Name>Deactivate</Name>
@@ -32,7 +32,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Deactivates the tool, similarly to releasing the mouse button.</Description>
  </Methods>
  <Methods>
    <Name>PlayAnimation</Name>
@@ -46,7 +46,7 @@
    <IsAsync>false</IsAsync>
    <IsObsolete>false</IsObsolete>
    <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Plays the specified animation on the holder of the tool.</Description>
  </Methods>
  <Events>
    <Name>Equipped</Name>
@@ -71,5 +71,5 @@
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Tools are objects that can be held by the player.</Description>
 </ClassDef>
--- a/xml/types/Truss.xml
+++ b/xml/types/Truss.xml
@@ -8,10 +8,10 @@
    <IsAccessibleByScripts>true</IsAccessibleByScripts>
    <IsReadOnly>false</IsReadOnly>
    <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>The speed at which the player can climb the truss.</Description>
  </Properties>
  <IsStatic>false</IsStatic>
  <IsAbstract>false</IsAbstract>
  <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Trusses are parts that can be climbed by the player.</Description>
 </ClassDef>