diff --git a/main.py b/main.py index 260fccd..0133509 100644 --- a/main.py +++ b/main.py @@ -125,10 +125,10 @@ def define_env(env): def staticclass(className): return """
!!! 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()`. -
""" % (className) +""" @env.macro def serverexclusive(): diff --git a/xml/types/Accessory.xml b/xml/types/Accessory.xml index d9295e7..6c303ef 100644 --- a/xml/types/Accessory.xml +++ b/xml/types/Accessory.xml @@ -8,10 +8,10 @@ true false false - Missing Documentation + Specifies the character attachment point false false true - Missing Documentation + Accessory represents a attachable object that can be equipped by a CharacterModel. diff --git a/xml/types/AchievementsService.xml b/xml/types/AchievementsService.xml index 67a465a..56e71d9 100644 --- a/xml/types/AchievementsService.xml +++ b/xml/types/AchievementsService.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Determine if achievement sound effect should play when user receives an achievement NotifyAchievements @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determine if achievement toast should show when user receives an achievement Award @@ -42,7 +42,7 @@ false false false - Missing Documentation + Award achievement to the user AwardAsync @@ -62,7 +62,7 @@ true false false - Missing Documentation + Award achievement to the user asynchronously. HasAchievement @@ -88,7 +88,7 @@ false false false - Missing Documentation + Check if user of ID has the achievement. HasAchievementAsync @@ -108,15 +108,18 @@ false false false - Missing Documentation + Check if player of ID has the achievement, asynchronously. GotAchievement - - Missing Documentation + + achievementID + number + + Fires when the local player got an achievement true false false - Missing Documentation + Service for managing achievements diff --git a/xml/types/BindableEvent.xml b/xml/types/BindableEvent.xml index da2cba4..a0a6608 100644 --- a/xml/types/BindableEvent.xml +++ b/xml/types/BindableEvent.xml @@ -18,8 +18,11 @@ Invoked - - Missing Documentation + + ... + any + + Fires when this bindable has been invoked false false diff --git a/xml/types/Camera.xml b/xml/types/Camera.xml index ebe0ec3..0848092 100644 --- a/xml/types/Camera.xml +++ b/xml/types/Camera.xml @@ -325,12 +325,12 @@ FirstPersonEntered - Missing Documentation + Fires when camera has entered first person FirstPersonExited - Missing Documentation + Fires when camera has exited first person false false diff --git a/xml/types/ChatService.xml b/xml/types/ChatService.xml index 4e220ee..e86f748 100644 --- a/xml/types/ChatService.xml +++ b/xml/types/ChatService.xml @@ -38,13 +38,23 @@ NewChatMessage - - Missing Documentation + + sender + Player + + + message + string + + Fires when new chat message has been received from player MessageReceived - - Missing Documentation + + message + string + + Fires when new message has been received from either `BroadcastMessage` or `UnicastMessage` true false diff --git a/xml/types/CreatorService.xml b/xml/types/CreatorService.xml index 8e60271..a6e577f 100644 --- a/xml/types/CreatorService.xml +++ b/xml/types/CreatorService.xml @@ -37,12 +37,12 @@ LocalTestStarted - Missing Documentation + Fires when local testing starts LocalTestStopped - Missing Documentation + Fires when local testing ends true false diff --git a/xml/types/Datastore.xml b/xml/types/Datastore.xml index 2fd994c..00380a7 100644 --- a/xml/types/Datastore.xml +++ b/xml/types/Datastore.xml @@ -61,7 +61,7 @@ Loaded - Missing Documentation + Fires when this datastore has been loaded false false diff --git a/xml/types/Explosion.xml b/xml/types/Explosion.xml index d0e53c1..56efb9f 100644 --- a/xml/types/Explosion.xml +++ b/xml/types/Explosion.xml @@ -44,8 +44,11 @@ Hitted - - Missing Documentation + + hit + Instance + + Fires when this explosion affects a hit false false diff --git a/xml/types/Game.xml b/xml/types/Game.xml index 46ff7f5..00c7a11 100644 --- a/xml/types/Game.xml +++ b/xml/types/Game.xml @@ -65,8 +65,11 @@ Rendered - - Missing Documentation + + delta + number + + Fires when the game has been rendered true false diff --git a/xml/types/Grabbable.xml b/xml/types/Grabbable.xml index 64bcea8..9ff41e5 100644 --- a/xml/types/Grabbable.xml +++ b/xml/types/Grabbable.xml @@ -44,13 +44,16 @@ Grabbed - - Missing Documentation + + grabber + Player + + Fires when this object has been grabbed Released - Missing Documentation + Fires when this object has been released false false diff --git a/xml/types/InputActionButton.xml b/xml/types/InputActionButton.xml index 5c5744f..6a54f02 100644 --- a/xml/types/InputActionButton.xml +++ b/xml/types/InputActionButton.xml @@ -29,12 +29,12 @@ Pressed - Missing Documentation + Fires when this button has been pressed Released - Missing Documentation + Fires when this button has been released false false diff --git a/xml/types/InputService.xml b/xml/types/InputService.xml index 216bf93..56c7dd4 100644 --- a/xml/types/InputService.xml +++ b/xml/types/InputService.xml @@ -191,37 +191,50 @@ GameFocused - Missing Documentation + Fires when the game has been focused GameUnfocused - Missing Documentation + Fires when the game has been unfocused GamepadConnected - Missing Documentation + Fires when gamepad is connected GamepadDisconnected - Missing Documentation + Fires when gamepad has been disconnected KeyDown - - Missing Documentation + + keycode + KeyCodeEnum + + Fires when key has been pressed KeyUp - - Missing Documentation + + keycode + KeyCodeEnum + + Fires when key has been released AxisValueChanged - - Missing Documentation + + keycode + KeyCodeEnum + + + value + float + + Fires when analog input has been changed true false diff --git a/xml/types/Instance.xml b/xml/types/Instance.xml index 45dba43..6f8eaf2 100644 --- a/xml/types/Instance.xml +++ b/xml/types/Instance.xml @@ -266,23 +266,35 @@ ChildAdded - - Missing Documentation + + child + Instance + + Fires when child has been added to this instance ChildRemoved - - Missing Documentation + + child + Instance + + Fires when child has been removed from this instance (either via reparent or delete) ChildDeleting - - Missing Documentation + + child + Instance + + Fires when child is being deleted from this instance ChildDeleted - - Missing Documentation + + child + Instance + + Fires when child has been deleted from this instance false true diff --git a/xml/types/NetworkEvent.xml b/xml/types/NetworkEvent.xml index 467e7b4..b74a10a 100644 --- a/xml/types/NetworkEvent.xml +++ b/xml/types/NetworkEvent.xml @@ -66,13 +66,27 @@ InvokedServer - - Missing Documentation + + sender + Player + + + msg + NetMessage + + Fires when server receives message from client InvokedClient - - Missing Documentation + + sender + nil + + + msg + NetMessage + + Fires when client receives message from server false false diff --git a/xml/types/NetworkedObject.xml b/xml/types/NetworkedObject.xml index 7720904..593c97e 100644 --- a/xml/types/NetworkedObject.xml +++ b/xml/types/NetworkedObject.xml @@ -116,7 +116,10 @@ PropertyChanged - + + propertyName + string + Missing Documentation diff --git a/xml/types/Physical.xml b/xml/types/Physical.xml index acf9c0e..7780ea6 100644 --- a/xml/types/Physical.xml +++ b/xml/types/Physical.xml @@ -50,28 +50,37 @@ Touched - - Missing Documentation + + hit + Physical + + Fires when this object has collide with other object TouchEnded - - Missing Documentation + + hit + Physical + + Fires when this object has stopped colliding with other object MouseEnter - Missing Documentation + Fires when cursor is hovered on this object. Only fired locally MouseExit - Missing Documentation + Fires when cursor leaves this object. Only fired locally Clicked - - Missing Documentation + + player + Player + + Fires when this object has been clicked by a player false true diff --git a/xml/types/Player.xml b/xml/types/Player.xml index 745e366..6fd95d0 100644 --- a/xml/types/Player.xml +++ b/xml/types/Player.xml @@ -234,13 +234,16 @@ Chatted - - Missing Documentation + + message + string + + Fires when this player chats Respawned - Missing Documentation + Fires when this player has respawned false false diff --git a/xml/types/Players.xml b/xml/types/Players.xml index d487e25..0e74e3f 100644 --- a/xml/types/Players.xml +++ b/xml/types/Players.xml @@ -64,13 +64,19 @@ PlayerAdded - - Missing Documentation + + player + Player + + Fires when player has connected PlayerRemoved - - Missing Documentation + + player + Player + + Fires when player has disconnected true false diff --git a/xml/types/PolytorianModel.xml b/xml/types/PolytorianModel.xml index 6d92cd7..c26dec3 100644 --- a/xml/types/PolytorianModel.xml +++ b/xml/types/PolytorianModel.xml @@ -251,12 +251,12 @@ RagdollStarted - Missing Documentation + Fires when ragdoll has been started RagdollStopped - Missing Documentation + Fires when ragdoll has been stopped false false diff --git a/xml/types/PreferencesService.xml b/xml/types/PreferencesService.xml index c810830..0244a52 100644 --- a/xml/types/PreferencesService.xml +++ b/xml/types/PreferencesService.xml @@ -20,7 +20,14 @@ SettingChanged - + + settingName + string + + + setTo + any + Missing Documentation true diff --git a/xml/types/Seat.xml b/xml/types/Seat.xml index bd15a11..91ad624 100644 --- a/xml/types/Seat.xml +++ b/xml/types/Seat.xml @@ -12,12 +12,18 @@ Sat - + + occupant + NPC + Missing Documentation Vacated - + + occupant + NPC + Missing Documentation false diff --git a/xml/types/Sound.xml b/xml/types/Sound.xml index c11f855..989171f 100644 --- a/xml/types/Sound.xml +++ b/xml/types/Sound.xml @@ -131,7 +131,7 @@ Loaded - Missing Documentation + Fires when this sound has loaded false false diff --git a/xml/types/Tool.xml b/xml/types/Tool.xml index 3addcf6..d0f9e61 100644 --- a/xml/types/Tool.xml +++ b/xml/types/Tool.xml @@ -51,22 +51,22 @@ Equipped - Missing Documentation + Fires when this tool has been equipped Unequipped - Missing Documentation + Fires when this tool has been unequipped Activated - Missing Documentation + Fires when this tool has been activated (via mouse press or `Tool:Activate`) Deactivated - Missing Documentation + Fires when this tool has been deactivated (via mouse release or `Tool:Deactivate`) false false diff --git a/xml/types/TweenObject.xml b/xml/types/TweenObject.xml index 9799445..3fa9426 100644 --- a/xml/types/TweenObject.xml +++ b/xml/types/TweenObject.xml @@ -339,12 +339,12 @@ Finished - Missing Documentation + Fires when this tween has finished Canceled - Missing Documentation + Fires when this tween has been canceled false false diff --git a/xml/types/UIButton.xml b/xml/types/UIButton.xml index bca709f..91e752b 100644 --- a/xml/types/UIButton.xml +++ b/xml/types/UIButton.xml @@ -5,7 +5,7 @@ Clicked - Missing Documentation + Fires when user click on this button false false diff --git a/xml/types/UIField.xml b/xml/types/UIField.xml index bd1105d..471c4a8 100644 --- a/xml/types/UIField.xml +++ b/xml/types/UIField.xml @@ -93,32 +93,32 @@ MouseEnter - Missing Documentation + Fires when user's cursor hovers on this UI MouseExit - Missing Documentation + Fires when user's cursor leaves this UI MouseDown - Missing Documentation + Fires when user hold down mouse on this UI MouseUp - Missing Documentation + Fires when user release mouse on this UI TransformChanged - Missing Documentation + Fires when this UI transform has been changed VisibilityChanged - Missing Documentation + Fires when this UI visibility has been changed false false diff --git a/xml/types/UITextInput.xml b/xml/types/UITextInput.xml index 6fe269a..6d638a1 100644 --- a/xml/types/UITextInput.xml +++ b/xml/types/UITextInput.xml @@ -100,13 +100,19 @@ Submitted - - Missing Documentation + + text + string + + Fires when user submitted the text Changed - - Missing Documentation + + text + string + + Fires when user changed the text false false diff --git a/xml/types/ValueBase.xml b/xml/types/ValueBase.xml index 30599cf..aa18d51 100644 --- a/xml/types/ValueBase.xml +++ b/xml/types/ValueBase.xml @@ -5,7 +5,7 @@ Changed - Missing Documentation + Fires when value has been changed false true