PTSignal docs

main.py

@@ -125,10 +125,10 @@ def define_env(env):
     def staticclass(className):
         return """<div data-search-exclude markdown>
 !!! tip "Static Class"
-    This object is a static class. It can be accessed by using its name as a keyword like this: `%s`.
+    This object is a static class. It can be accessed by using its name as a keyword.
 
     Additionally, it cannot be created in the creator menu or with `Instance.New()`.
-</div>""" % (className)
+</div>"""
 
     @env.macro
     def serverexclusive():

xml/types/Accessory.xml

@@ -8,10 +8,10 @@
     <IsAccessibleByScripts>true</IsAccessibleByScripts>
     <IsReadOnly>false</IsReadOnly>
     <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Specifies the character attachment point</Description>
   </Properties>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>
   <IsInstantiatable>true</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Accessory represents a attachable object that can be equipped by a CharacterModel.</Description>
 </ClassDef>

xml/types/AchievementsService.xml

@@ -8,7 +8,7 @@
     <IsAccessibleByScripts>true</IsAccessibleByScripts>
     <IsReadOnly>false</IsReadOnly>
     <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determine if achievement sound effect should play when user receives an achievement</Description>
   </Properties>
   <Properties>
     <Name>NotifyAchievements</Name>
@@ -16,7 +16,7 @@
     <IsAccessibleByScripts>true</IsAccessibleByScripts>
     <IsReadOnly>false</IsReadOnly>
     <IsObsolete>false</IsObsolete>
-    <Description>Missing Documentation</Description>
+    <Description>Determine if achievement toast should show when user receives an achievement</Description>
   </Properties>
   <Methods>
     <Name>Award</Name>
@@ -42,7 +42,7 @@
     <IsAsync>false</IsAsync>
     <IsObsolete>false</IsObsolete>
     <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Award achievement to the user</Description>
   </Methods>
   <Methods>
     <Name>AwardAsync</Name>
@@ -62,7 +62,7 @@
     <IsAsync>true</IsAsync>
     <IsObsolete>false</IsObsolete>
     <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Award achievement to the user asynchronously.</Description>
   </Methods>
   <Methods>
     <Name>HasAchievement</Name>
@@ -88,7 +88,7 @@
     <IsAsync>false</IsAsync>
     <IsObsolete>false</IsObsolete>
     <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Check if user of ID has the achievement.</Description>
   </Methods>
   <Methods>
     <Name>HasAchievementAsync</Name>
@@ -108,15 +108,18 @@
     <IsAsync>false</IsAsync>
     <IsObsolete>false</IsObsolete>
     <IsStatic>false</IsStatic>
-    <Description>Missing Documentation</Description>
+    <Description>Check if player of ID has the achievement, asynchronously.</Description>
   </Methods>
   <Events>
     <Name>GotAchievement</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>achievementID</Name>
+      <Type>number</Type>
+    </Arguments>
+    <Description>Fires when the local player got an achievement</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>
   <IsInstantiatable>false</IsInstantiatable>
-  <Description>Missing Documentation</Description>
+  <Description>Service for managing achievements</Description>
 </ClassDef>

xml/types/BindableEvent.xml

@@ -18,8 +18,11 @@
   </Methods>
   <Events>
     <Name>Invoked</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>...</Name>
+      <Type>any</Type>
+    </Arguments>
+    <Description>Fires when this bindable has been invoked</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Camera.xml

@@ -325,12 +325,12 @@
   <Events>
     <Name>FirstPersonEntered</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when camera has entered first person</Description>
   </Events>
   <Events>
     <Name>FirstPersonExited</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when camera has exited first person</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/ChatService.xml

@@ -38,13 +38,23 @@
   </Methods>
   <Events>
     <Name>NewChatMessage</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>sender</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Arguments>
+      <Name>message</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Description>Fires when new chat message has been received from player</Description>
   </Events>
   <Events>
     <Name>MessageReceived</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>message</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Description>Fires when new message has been received from either `BroadcastMessage` or `UnicastMessage`</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/CreatorService.xml

@@ -37,12 +37,12 @@
   <Events>
     <Name>LocalTestStarted</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when local testing starts</Description>
   </Events>
   <Events>
     <Name>LocalTestStopped</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when local testing ends</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Datastore.xml

@@ -61,7 +61,7 @@
   <Events>
     <Name>Loaded</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this datastore has been loaded</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Explosion.xml

@@ -44,8 +44,11 @@
   </Properties>
   <Events>
     <Name>Hitted</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>hit</Name>
+      <Type>Instance</Type>
+    </Arguments>
+    <Description>Fires when this explosion affects a hit</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Game.xml

@@ -65,8 +65,11 @@
   </Events>
   <Events>
     <Name>Rendered</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>delta</Name>
+      <Type>number</Type>
+    </Arguments>
+    <Description>Fires when the game has been rendered</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Grabbable.xml

@@ -44,13 +44,16 @@
   </Properties>
   <Events>
     <Name>Grabbed</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>grabber</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Description>Fires when this object has been grabbed</Description>
   </Events>
   <Events>
     <Name>Released</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this object has been released</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/InputActionButton.xml

@@ -29,12 +29,12 @@
   <Events>
     <Name>Pressed</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this button has been pressed</Description>
   </Events>
   <Events>
     <Name>Released</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this button has been released</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/InputService.xml

@@ -191,37 +191,50 @@
   <Events>
     <Name>GameFocused</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when the game has been focused</Description>
   </Events>
   <Events>
     <Name>GameUnfocused</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when the game has been unfocused</Description>
   </Events>
   <Events>
     <Name>GamepadConnected</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when gamepad is connected</Description>
   </Events>
   <Events>
     <Name>GamepadDisconnected</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when gamepad has been disconnected</Description>
   </Events>
   <Events>
     <Name>KeyDown</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>keycode</Name>
+      <Type>KeyCodeEnum</Type>
+    </Arguments>
+    <Description>Fires when key has been pressed</Description>
   </Events>
   <Events>
     <Name>KeyUp</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>keycode</Name>
+      <Type>KeyCodeEnum</Type>
+    </Arguments>
+    <Description>Fires when key has been released</Description>
   </Events>
   <Events>
     <Name>AxisValueChanged</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>keycode</Name>
+      <Type>KeyCodeEnum</Type>
+    </Arguments>
+    <Arguments>
+      <Name>value</Name>
+      <Type>float</Type>
+    </Arguments>
+    <Description>Fires when analog input has been changed</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Instance.xml

@@ -266,23 +266,35 @@
   </Methods>
   <Events>
     <Name>ChildAdded</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>child</Name>
+      <Type>Instance</Type>
+    </Arguments>
+    <Description>Fires when child has been added to this instance</Description>
   </Events>
   <Events>
     <Name>ChildRemoved</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>child</Name>
+      <Type>Instance</Type>
+    </Arguments>
+    <Description>Fires when child has been removed from this instance (either via reparent or delete)</Description>
   </Events>
   <Events>
     <Name>ChildDeleting</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>child</Name>
+      <Type>Instance</Type>
+    </Arguments>
+    <Description>Fires when child is being deleted from this instance</Description>
   </Events>
   <Events>
     <Name>ChildDeleted</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>child</Name>
+      <Type>Instance</Type>
+    </Arguments>
+    <Description>Fires when child has been deleted from this instance</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>true</IsAbstract>

xml/types/NetworkEvent.xml

@@ -66,13 +66,27 @@
   </Methods>
   <Events>
     <Name>InvokedServer</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>sender</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Arguments>
+      <Name>msg</Name>
+      <Type>NetMessage</Type>
+    </Arguments>
+    <Description>Fires when server receives message from client</Description>
   </Events>
   <Events>
     <Name>InvokedClient</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>sender</Name>
+      <Type>nil</Type>
+    </Arguments>
+    <Arguments>
+      <Name>msg</Name>
+      <Type>NetMessage</Type>
+    </Arguments>
+    <Description>Fires when client receives message from server</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/NetworkedObject.xml

@@ -116,7 +116,10 @@
   </Methods>
   <Events>
     <Name>PropertyChanged</Name>
-    <Arguments></Arguments>
+    <Arguments>
+      <Name>propertyName</Name>
+      <Type>string</Type>
+    </Arguments>
     <Description>Missing Documentation</Description>
   </Events>
   <Events>

xml/types/Physical.xml

@@ -50,28 +50,37 @@
   </Methods>
   <Events>
     <Name>Touched</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>hit</Name>
+      <Type>Physical</Type>
+    </Arguments>
+    <Description>Fires when this object has collide with other object</Description>
   </Events>
   <Events>
     <Name>TouchEnded</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>hit</Name>
+      <Type>Physical</Type>
+    </Arguments>
+    <Description>Fires when this object has stopped colliding with other object</Description>
   </Events>
   <Events>
     <Name>MouseEnter</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when cursor is hovered on this object. Only fired locally</Description>
   </Events>
   <Events>
     <Name>MouseExit</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when cursor leaves this object. Only fired locally</Description>
   </Events>
   <Events>
     <Name>Clicked</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>player</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Description>Fires when this object has been clicked by a player</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>true</IsAbstract>

xml/types/Player.xml

@@ -234,13 +234,16 @@
   </Methods>
   <Events>
     <Name>Chatted</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>message</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Description>Fires when this player chats</Description>
   </Events>
   <Events>
     <Name>Respawned</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this player has respawned</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Players.xml

@@ -64,13 +64,19 @@
   </Methods>
   <Events>
     <Name>PlayerAdded</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>player</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Description>Fires when player has connected</Description>
   </Events>
   <Events>
     <Name>PlayerRemoved</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>player</Name>
+      <Type>Player</Type>
+    </Arguments>
+    <Description>Fires when player has disconnected</Description>
   </Events>
   <IsStatic>true</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/PolytorianModel.xml

@@ -251,12 +251,12 @@
   <Events>
     <Name>RagdollStarted</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when ragdoll has been started</Description>
   </Events>
   <Events>
     <Name>RagdollStopped</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when ragdoll has been stopped</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/PreferencesService.xml

@@ -20,7 +20,14 @@
   </Properties>
   <Events>
     <Name>SettingChanged</Name>
-    <Arguments></Arguments>
+    <Arguments>
+      <Name>settingName</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Arguments>
+      <Name>setTo</Name>
+      <Type>any</Type>
+    </Arguments>
     <Description>Missing Documentation</Description>
   </Events>
   <IsStatic>true</IsStatic>

xml/types/Seat.xml

@@ -12,12 +12,18 @@
   </Properties>
   <Events>
     <Name>Sat</Name>
-    <Arguments></Arguments>
+    <Arguments>
+      <Name>occupant</Name>
+      <Type>NPC</Type>
+    </Arguments>
     <Description>Missing Documentation</Description>
   </Events>
   <Events>
     <Name>Vacated</Name>
-    <Arguments></Arguments>
+    <Arguments>
+      <Name>occupant</Name>
+      <Type>NPC</Type>
+    </Arguments>
     <Description>Missing Documentation</Description>
   </Events>
   <IsStatic>false</IsStatic>

xml/types/Sound.xml

@@ -131,7 +131,7 @@
   <Events>
     <Name>Loaded</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this sound has loaded</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/Tool.xml

@@ -51,22 +51,22 @@
   <Events>
     <Name>Equipped</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tool has been equipped</Description>
   </Events>
   <Events>
     <Name>Unequipped</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tool has been unequipped</Description>
   </Events>
   <Events>
     <Name>Activated</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tool has been activated (via mouse press or `Tool:Activate`)</Description>
   </Events>
   <Events>
     <Name>Deactivated</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tool has been deactivated (via mouse release or `Tool:Deactivate`)</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/TweenObject.xml

@@ -339,12 +339,12 @@
   <Events>
     <Name>Finished</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tween has finished</Description>
   </Events>
   <Events>
     <Name>Canceled</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this tween has been canceled</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/UIButton.xml

@@ -5,7 +5,7 @@
   <Events>
     <Name>Clicked</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when user click on this button</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/UIField.xml

@@ -93,32 +93,32 @@
   <Events>
     <Name>MouseEnter</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when user&apos;s cursor hovers on this UI</Description>
   </Events>
   <Events>
     <Name>MouseExit</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when user&apos;s cursor leaves this UI</Description>
   </Events>
   <Events>
     <Name>MouseDown</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when user hold down mouse on this UI</Description>
   </Events>
   <Events>
     <Name>MouseUp</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when user release mouse on this UI</Description>
   </Events>
   <Events>
     <Name>TransformChanged</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this UI transform has been changed</Description>
   </Events>
   <Events>
     <Name>VisibilityChanged</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when this UI visibility has been changed</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/UITextInput.xml

@@ -100,13 +100,19 @@
   </Methods>
   <Events>
     <Name>Submitted</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>text</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Description>Fires when user submitted the text</Description>
   </Events>
   <Events>
     <Name>Changed</Name>
-    <Arguments></Arguments>
+    <Arguments>
-    <Description>Missing Documentation</Description>
+      <Name>text</Name>
+      <Type>string</Type>
+    </Arguments>
+    <Description>Fires when user changed the text</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>false</IsAbstract>

xml/types/ValueBase.xml

@@ -5,7 +5,7 @@
   <Events>
     <Name>Changed</Name>
     <Arguments></Arguments>
-    <Description>Missing Documentation</Description>
+    <Description>Fires when value has been changed</Description>
   </Events>
   <IsStatic>false</IsStatic>
   <IsAbstract>true</IsAbstract>