diff --git a/autogen/mdgen.js b/autogen/mdgen.js index fd30328..ca50830 100644 --- a/autogen/mdgen.js +++ b/autogen/mdgen.js @@ -153,6 +153,7 @@ for (const xmlFile of xmlEnumFiles) { appendLine("---") appendLine("title: " + e.Name) appendLine("description: " + (e.Description && e.Description !== "Missing Documentation" ? e.Description : "")) + appendLine("icon: polytoria/Enum") appendLine("---") appendLine("") appendLine("# " + e.Name) diff --git a/docs/assets/extra.css b/docs/assets/extra.css new file mode 100644 index 0000000..0da0887 --- /dev/null +++ b/docs/assets/extra.css @@ -0,0 +1,40 @@ +[dir='ltr'] .md-header__title { + margin-left: initial; +} + +[dir='rtl'] .md-header__title { + margin-right: initial; +} + +.md-nav__link svg[viewBox='0 0 48 48'] { + width: 22px; + height: 22px; + margin-right: -4px; +} + +svg[viewBox='0 0 48 48'] { + color: transparent !important; + transform: translateY(0.5px); +} + +.md-nav__link span:not(:only-child) { + font-size: 1em; + margin-top: 0.11em; +} + +p:has(small.parameters-text), +p:has(small.parameters-text)+h3 { + margin: 0px; +} + +h3:has(+ .admonition.quote) { + margin-bottom: 0px; +} + +h3+.admonition.quote { + margin-top: 5px; +} + +.contributors-link-footer { + color: #007bff !important; +} \ No newline at end of file diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..ccf0a91 --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index da40363..d88d920 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,10 @@ theme: - navigation.top - toc.follow name: material + custom_dir: docs/theme + logo: assets/logo.svg + font: + text: Rubik palette: - scheme: slate primary: blue @@ -59,4 +63,8 @@ markdown_extensions: emoji_generator: !!python/name:material.extensions.emoji.to_svg options: custom_icons: - - docs/theme/.icons \ No newline at end of file + - docs/theme/.icons +extra_css: + - assets/extra.css +validation: + absolute_links: ignore \ No newline at end of file diff --git a/xml/types/AssetService.xml b/xml/types/AssetService.xml index eaebc16..1444bae 100644 --- a/xml/types/AssetService.xml +++ b/xml/types/AssetService.xml @@ -14,7 +14,7 @@ false false false - Missing Documentation + Create new asset with the class name NewPTImage @@ -28,7 +28,7 @@ false false false - Missing Documentation + Create new image from Polytoria with the target ID NewPTAudio @@ -42,7 +42,7 @@ false false false - Missing Documentation + Create new audio from Polytoria with the target ID NewPTMesh @@ -56,10 +56,10 @@ false false false - Missing Documentation + Create new mesh from Polytoria with the target ID true false false - Missing Documentation + Service for managing assets diff --git a/xml/types/AudioAsset.xml b/xml/types/AudioAsset.xml index eef7354..bba59f5 100644 --- a/xml/types/AudioAsset.xml +++ b/xml/types/AudioAsset.xml @@ -5,5 +5,5 @@ false true false - Missing Documentation + Abstract class for audio diff --git a/xml/types/BaseAsset.xml b/xml/types/BaseAsset.xml index 36d1cce..a58fab4 100644 --- a/xml/types/BaseAsset.xml +++ b/xml/types/BaseAsset.xml @@ -5,5 +5,5 @@ false true false - Missing Documentation + Base class for all assets diff --git a/xml/types/BindableEvent.xml b/xml/types/BindableEvent.xml index a0a6608..8a3bd7d 100644 --- a/xml/types/BindableEvent.xml +++ b/xml/types/BindableEvent.xml @@ -14,7 +14,7 @@ false false false - Missing Documentation + Invoke this event with parameters Invoked @@ -22,10 +22,10 @@ ... any - Fires when this bindable has been invoked + Fires when this event has been invoked false false true - Missing Documentation + BindableEvent are events that can be called to communicate between scripts in the same boundary. diff --git a/xml/types/BodyPosition.xml b/xml/types/BodyPosition.xml index 50d45f7..0454238 100644 --- a/xml/types/BodyPosition.xml +++ b/xml/types/BodyPosition.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Determines the target position that the body applies forces to get to. Force @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determines how much force the body applies. AcceptanceDistance @@ -24,10 +24,10 @@ true false false - Missing Documentation + Determines how close the body has to be to the target position to stop applying forces to it. false false true - Missing Documentation + BodyPosition are objects that apply a force to their parent until it moves toward the target position. diff --git a/xml/types/BoolValue.xml b/xml/types/BoolValue.xml index 820b80e..4867efc 100644 --- a/xml/types/BoolValue.xml +++ b/xml/types/BoolValue.xml @@ -8,10 +8,10 @@ true false false - Missing Documentation + The value of this object. false false true - Missing Documentation + BoolValue is a ValueBase that stores a boolean. diff --git a/xml/types/BuiltInAudioAsset.xml b/xml/types/BuiltInAudioAsset.xml index bdedb53..599e2fb 100644 --- a/xml/types/BuiltInAudioAsset.xml +++ b/xml/types/BuiltInAudioAsset.xml @@ -8,10 +8,10 @@ false false false - Missing Documentation + The target audio to use false false true - Missing Documentation + Audio asset that's built-in with the client diff --git a/xml/types/BuiltInFontAsset.xml b/xml/types/BuiltInFontAsset.xml index 5069e2d..7e3a4d3 100644 --- a/xml/types/BuiltInFontAsset.xml +++ b/xml/types/BuiltInFontAsset.xml @@ -8,10 +8,10 @@ false false false - Missing Documentation + Target font to use false false true - Missing Documentation + Font asset that's built-in with the client diff --git a/xml/types/Camera.xml b/xml/types/Camera.xml index 0848092..7b43dcf 100644 --- a/xml/types/Camera.xml +++ b/xml/types/Camera.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Determines or returns the camera's current mode. FOV @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determines or returns the camera's field of view. ClipThroughWalls @@ -24,7 +24,7 @@ true false false - Missing Documentation + Determines whether or not the camera should clip through walls. MinDistance @@ -32,7 +32,7 @@ true false false - Missing Documentation + The camera's minimum distance from the player in Follow mode. MaxDistance @@ -40,7 +40,7 @@ true false false - Missing Documentation + Determines camera's maximum distance from the player in Follow mode. Distance @@ -48,7 +48,7 @@ true false false - Missing Documentation + Determines the distance between the camera and the player when the camera is in Follow mode. ScrollSensitivity @@ -56,7 +56,7 @@ true false false - Missing Documentation + Determines the scroll move speed of the camera. Orthographic @@ -64,7 +64,7 @@ true false false - Missing Documentation + Determines whether or not the camera should render in orthographic (2D) mode or not (3D). FollowLerp @@ -72,7 +72,7 @@ true false false - Missing Documentation + Determines whether or not to use lerping in Follow mode. LerpSpeed @@ -80,7 +80,7 @@ true false false - Missing Documentation + Determines the lerp speed of the camera when lerping is enabled. OrthographicSize @@ -88,7 +88,7 @@ true false false - Missing Documentation + Determines the half-size of the camera when in orthographic mode. PositionOffset @@ -96,7 +96,7 @@ true false false - Missing Documentation + Determines the camera's offset from its position. RotationOffset @@ -104,7 +104,7 @@ true false false - Missing Documentation + Determines the camera's offset from its rotation. IsFirstPerson @@ -112,7 +112,7 @@ true true false - Missing Documentation + Returns whether or not the camera is in first person. CanLock @@ -120,7 +120,7 @@ true false false - Missing Documentation + Determine if camera can be ctrl locked. SensitivityMultiplier @@ -128,7 +128,7 @@ true false false - Missing Documentation + Multipler for camera sensitivity Sensitivity @@ -136,7 +136,7 @@ true true false - Missing Documentation + Current sensitivity of the camera HorizontalSpeed @@ -144,7 +144,7 @@ true false false - Missing Documentation + Determines the horizontal movement speed of the camera in Follow mode. VerticalSpeed @@ -152,7 +152,7 @@ true false false - Missing Documentation + Determines the vertical move speed of the camera. ScrollLerpSpeed @@ -160,7 +160,7 @@ true false false - Missing Documentation + Determines the lerp amount when scrolling CtrlLocked @@ -168,7 +168,7 @@ true false false - Missing Documentation + Determine if camera is in Ctrl lock mode AlwaysLocked @@ -176,7 +176,7 @@ true false false - Missing Documentation + Determine if camera should always be in locked mode Target @@ -184,7 +184,7 @@ true false false - Missing Documentation + The target of Follow mode ViewportPointToRay @@ -210,7 +210,7 @@ false false false - Missing Documentation + Cast a ray from the camera at the specified ViewportPoint (Vector3 with components with values in range of 0 - 1 describing how far a point is to to right and to the top of the screen) into the game world ScreenPointToRay @@ -236,7 +236,7 @@ false false false - Missing Documentation + Cast a ray from the camera at screen point into the game world ViewportToScreenPoint @@ -250,7 +250,7 @@ false false false - Missing Documentation + Transforms `pos` from viewport space into screen space. ViewportToWorldPoint @@ -264,7 +264,7 @@ false false false - Missing Documentation + Transforms `pos` from viewport space into world space. WorldToViewportPoint @@ -278,7 +278,7 @@ false false false - Missing Documentation + Transforms `pos` from world space into viewport space. WorldToScreenPoint @@ -292,7 +292,7 @@ false false false - Missing Documentation + Transforms `pos` from world space into screen space. ScreenToViewportPoint @@ -306,7 +306,7 @@ false false false - Missing Documentation + Transforms `pos` from screen space into viewport space. ScreenToWorldPoint @@ -320,7 +320,7 @@ false false false - Missing Documentation + Transforms `pos` from screen space into world space. FirstPersonEntered @@ -335,5 +335,5 @@ false false true - Missing Documentation + Camera is a class that represents the local player's camera. diff --git a/xml/types/CaptureService.xml b/xml/types/CaptureService.xml index 83f1b5d..bd90943 100644 --- a/xml/types/CaptureService.xml +++ b/xml/types/CaptureService.xml @@ -8,7 +8,7 @@ true true false - Missing Documentation + Returns whenever the capture is on cooldown. CanCapture @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determines if user/scripts can take a picture. DefaultCaptureOverlay @@ -24,7 +24,7 @@ true false false - Missing Documentation + Default capture overlay for all captures SpectatorAttach @@ -32,7 +32,7 @@ true false false - Missing Documentation + Attaches a spectator camera at dynamic for use with spectator mode. TakePhotoAtDynamic @@ -58,7 +58,7 @@ true false false - Missing Documentation + Take a photo at dynamic TakePhotoAt @@ -90,10 +90,10 @@ true false false - Missing Documentation + Take photo at `pos` for position and `rot` for rotation, optional `photoSize` defines the size, and optional UI `overlay` can be passed to include it in the result photo. true false false - Missing Documentation + Service for capturing photos diff --git a/xml/types/CharacterModel.xml b/xml/types/CharacterModel.xml index d76a830..5be52b6 100644 --- a/xml/types/CharacterModel.xml +++ b/xml/types/CharacterModel.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + The animator for this character GetAttachment @@ -22,10 +22,10 @@ false false false - Missing Documentation + Get attachment dynamic from this character false false true - Missing Documentation + Base class for Character Models diff --git a/xml/types/ChatService.xml b/xml/types/ChatService.xml index e86f748..84957e5 100644 --- a/xml/types/ChatService.xml +++ b/xml/types/ChatService.xml @@ -14,7 +14,7 @@ false false false - Missing Documentation + Sends a chat message to all players. UnicastMessage @@ -34,7 +34,7 @@ false false false - Missing Documentation + Sends a chat message to a specific player. NewChatMessage @@ -59,5 +59,5 @@ true false false - Missing Documentation + Chat is a static class used for various actions regarding the chat. diff --git a/xml/types/ClientScript.xml b/xml/types/ClientScript.xml index cea1b89..a33f67e 100644 --- a/xml/types/ClientScript.xml +++ b/xml/types/ClientScript.xml @@ -5,5 +5,5 @@ false false true - Missing Documentation + ClientScript is a script that runs locally for each player. It can only see what the player can see. diff --git a/xml/types/Color.xml b/xml/types/Color.xml index c688d37..11109a5 100644 --- a/xml/types/Color.xml +++ b/xml/types/Color.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Red color component G @@ -16,7 +16,7 @@ true false false - Missing Documentation + Green color component B @@ -24,7 +24,7 @@ true false false - Missing Documentation + Blue color component A @@ -32,7 +32,7 @@ true false false - Missing Documentation + Alpha (opacity) color component New @@ -40,7 +40,7 @@ false false true - Missing Documentation + Creates a new black color. New @@ -54,7 +54,7 @@ false false true - Missing Documentation + Creates a new Color with an R, G and B value of `d` New @@ -80,7 +80,7 @@ false false true - Missing Documentation + Creates a new Color with the set R, G and B values and an alpha value of 1 New @@ -112,7 +112,7 @@ false false true - Missing Documentation + Creates a new Color with the set R, G, B and A values Random @@ -120,7 +120,7 @@ false false true - Missing Documentation + Returns a random color with an alpha value of 1. FromHex @@ -134,7 +134,7 @@ false false true - Missing Documentation + Creates a new Color from the specified hex value. Lerp @@ -160,10 +160,12 @@ false false true - Missing Documentation + Linearly interpolates colors a and b by t. false false false - Missing Documentation + Color is a data type that represents a color. + + The alpha property is between 0 and 1. 0 is fully transparent and 1 is fully visible. diff --git a/xml/types/ColorAdjustModifier.xml b/xml/types/ColorAdjustModifier.xml index 8eda689..503e4e2 100644 --- a/xml/types/ColorAdjustModifier.xml +++ b/xml/types/ColorAdjustModifier.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Determine the brightness adjustment Contrast @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determine the contrast adjustment Saturation @@ -24,7 +24,7 @@ true false false - Missing Documentation + Determine the saturation adjustment TintColor @@ -32,10 +32,10 @@ true false false - Missing Documentation + Determine the tint color false false true - Missing Documentation + ColorAdjustModifier is a LightingModifier that allows the adjustment of lighting diff --git a/xml/types/ColorSeries.xml b/xml/types/ColorSeries.xml index 75c026e..3fb8e06 100644 --- a/xml/types/ColorSeries.xml +++ b/xml/types/ColorSeries.xml @@ -8,7 +8,7 @@ true true false - Missing Documentation + Returns the point count of this color series New @@ -16,7 +16,7 @@ false false true - Missing Documentation + Create new color range with 2 default points New @@ -36,10 +36,10 @@ false false true - Missing Documentation + Create color series by this color range false false false - Missing Documentation + Color series is a data type that represents a collection of color and points, also known as gradient. diff --git a/xml/types/ColorValue.xml b/xml/types/ColorValue.xml index 73b5737..e19de15 100644 --- a/xml/types/ColorValue.xml +++ b/xml/types/ColorValue.xml @@ -8,10 +8,10 @@ true false false - Missing Documentation + The value of this object. false false true - Missing Documentation + ColorValue is a ValueBase that stores a color. diff --git a/xml/types/CoreUIService.xml b/xml/types/CoreUIService.xml index a252203..fa07079 100644 --- a/xml/types/CoreUIService.xml +++ b/xml/types/CoreUIService.xml @@ -8,7 +8,7 @@ true false false - Missing Documentation + Determines whether or not the user card (in the upper right hand corner above the leaderboard) is visible. UseChat @@ -16,7 +16,7 @@ true false false - Missing Documentation + Determines whether or not the chat box is visible. UseHealthBar @@ -24,7 +24,7 @@ true false false - Missing Documentation + Determines whether or not the player's health bar is visible. UseLeaderboard @@ -32,7 +32,7 @@ true false false - Missing Documentation + Determines whether or not the player list/leaderboard is visible. UseHotbar @@ -40,7 +40,7 @@ true false false - Missing Documentation + Determines whether or not the hot bar is visible. UseMenuButton @@ -48,7 +48,7 @@ true false false - Missing Documentation + Determines whether or not the menu button is visible. UseEmoteWheel @@ -56,7 +56,7 @@ true false false - Missing Documentation + Determines whether or not the emote wheel is visible. CanRespawn @@ -64,10 +64,10 @@ true false false - Missing Documentation + Determines whether or not the player can respawn. true false false - Missing Documentation + CoreUI is a static class that allows for the toggling of certain core GUI. diff --git a/xml/types/CreatorContextService.xml b/xml/types/CreatorContextService.xml index 516b4be..cf0f8e0 100644 --- a/xml/types/CreatorContextService.xml +++ b/xml/types/CreatorContextService.xml @@ -5,5 +5,5 @@ true false false - Missing Documentation + CreatorContextService is a service that manage per game specific tools, such as Selections and History. This class is only available in the creator. diff --git a/xml/types/CreatorGUI.xml b/xml/types/CreatorGUI.xml index 4c02908..31c1847 100644 --- a/xml/types/CreatorGUI.xml +++ b/xml/types/CreatorGUI.xml @@ -5,5 +5,5 @@ false false false - Missing Documentation + CreatorGUI is an object that allows GUI to overlay on top of the viewport in the creator. This class is only available in the creator. diff --git a/xml/types/CreatorHistory.xml b/xml/types/CreatorHistory.xml index 118a904..ec1d1e0 100644 --- a/xml/types/CreatorHistory.xml +++ b/xml/types/CreatorHistory.xml @@ -55,5 +55,5 @@ false false false - Missing Documentation + CreatorHistory is a class that manages history (undo-redo) of this game instance. This class is only available in the creator. diff --git a/xml/types/CreatorInterface.xml b/xml/types/CreatorInterface.xml index d030e95..f3e50aa 100644 --- a/xml/types/CreatorInterface.xml +++ b/xml/types/CreatorInterface.xml @@ -77,5 +77,5 @@ false false false - Missing Documentation + CreatorInterface represent the user interface of the creator. This class is only available in the creator. diff --git a/xml/types/CreatorSelections.xml b/xml/types/CreatorSelections.xml index fc1a181..6fe701d 100644 --- a/xml/types/CreatorSelections.xml +++ b/xml/types/CreatorSelections.xml @@ -183,5 +183,5 @@ false false false - Missing Documentation + CreatorSelections is an object that manages selections in the game instance. This class is only available in the creator. diff --git a/xml/types/CreatorService.xml b/xml/types/CreatorService.xml index a6e577f..f2224f6 100644 --- a/xml/types/CreatorService.xml +++ b/xml/types/CreatorService.xml @@ -47,5 +47,5 @@ true false false - Missing Documentation + CreatorService is the class that manages the creator. This class is only available in the creator. diff --git a/xml/types/Datastore.xml b/xml/types/Datastore.xml index 00380a7..9127879 100644 --- a/xml/types/Datastore.xml +++ b/xml/types/Datastore.xml @@ -66,5 +66,5 @@ false false false - Missing Documentation + Datastore is an object that represent datastore connection. diff --git a/xml/types/DatastoreService.xml b/xml/types/DatastoreService.xml index 1af5d66..1ff5666 100644 --- a/xml/types/DatastoreService.xml +++ b/xml/types/DatastoreService.xml @@ -19,5 +19,5 @@ true false false - Missing Documentation + Datastore (not to be confused with the Datastore data type) is a service used for storing data between place sessions. diff --git a/xml/types/Decal.xml b/xml/types/Decal.xml index 5913416..4200bc5 100644 --- a/xml/types/Decal.xml +++ b/xml/types/Decal.xml @@ -29,5 +29,5 @@ false false true - Missing Documentation + Decals are objects that can have an image texture and are wrapped around other objects. diff --git a/xml/types/Dynamic.xml b/xml/types/Dynamic.xml index 74681b0..55840ee 100644 --- a/xml/types/Dynamic.xml +++ b/xml/types/Dynamic.xml @@ -292,7 +292,7 @@ GetBounds - Aabb + Bounds false false false @@ -301,5 +301,5 @@ false false true - Missing Documentation + Dynamic is the base class where all objects with a position, rotation and scale derive from.