Polytoria/Docs-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

a

Browse Source
This commit is contained in:
maji
2025-12-29 19:52:18 +07:00
parent 6f135a9e3c
commit bade87243c
32 changed files with 167 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
autogen/mdgen.js
View File

@@ -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)

40
docs/assets/extra.css Normal file
View File

@@ -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;
}

6
docs/assets/logo.svg Normal file
View File

@@ -0,0 +1,6 @@
<svg width="200" height="214" viewBox="0 0 200 214" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M52.9032 67.188L95.6991 42.8036C97.0068 42.0598 98.4902 41.6682 100 41.6682C101.51 41.6682 102.994 42.0598 104.301 42.8036L147.112 67.188C148.428 67.9373 149.923 68.3295 151.443 68.3246C152.964 68.3196 154.456 67.9177 155.768 67.1598L175.065 56.0162C176.364 55.2663 177.44 54.1938 178.186 52.9059C178.932 51.6181 179.322 50.1599 179.317 48.6771C179.312 47.1943 178.912 45.7388 178.157 44.4559C177.402 43.173 176.319 42.1078 175.015 41.3665L104.301 1.13532C102.994 0.39156 101.51 0 100 0C98.4902 0 97.0068 0.39156 95.6991 1.13532L24.9891 41.3665C23.6863 42.108 22.6037 43.1732 21.8494 44.4557C21.0951 45.7382 20.6955 47.1932 20.6904 48.6754C20.6854 50.1576 21.075 51.6152 21.8205 52.9027C22.566 54.1902 23.6412 55.2625 24.9389 56.0127L44.2437 67.1633C45.5559 67.9213 47.0488 68.323 48.57 68.3274C50.0913 68.3317 51.5865 67.9385 52.9032 67.188Z" fill="white"/>
<path d="M163.799 95.3967V144.194C163.799 145.686 163.399 147.151 162.64 148.442C161.881 149.732 160.79 150.803 159.477 151.545L116.867 175.615C115.553 176.358 114.462 177.428 113.703 178.719C112.944 180.01 112.544 181.475 112.544 182.967V204.685C112.545 206.173 112.942 207.634 113.697 208.922C114.453 210.21 115.539 211.279 116.846 212.023C118.154 212.767 119.637 213.158 121.147 213.158C122.657 213.158 124.14 212.766 125.448 212.023L195.699 172.028C197.006 171.284 198.092 170.215 198.847 168.927C199.602 167.639 200 166.178 200 164.691V84.6486C200.002 83.1603 199.605 81.6979 198.851 80.4084C198.097 79.1189 197.011 78.0479 195.703 77.303C194.395 76.5582 192.911 76.1659 191.4 76.1655C189.889 76.1651 188.405 76.5566 187.097 77.3008L168.1 88.0489C166.791 88.7934 165.704 89.8646 164.949 91.1545C164.194 92.4445 163.797 93.9076 163.799 95.3967Z" fill="white"/>
<path d="M36.2009 95.3967V144.194C36.2009 145.686 36.6005 147.151 37.3595 148.442C38.1185 149.732 39.2099 150.803 40.5235 151.545L83.133 175.615C84.4466 176.358 85.538 177.428 86.297 178.719C87.056 180.01 87.4557 181.475 87.4557 182.967V204.685C87.4554 206.173 87.0577 207.634 86.3025 208.922C85.5474 210.21 84.4615 211.279 83.1538 212.023C81.8462 212.767 80.3629 213.158 78.853 213.158C77.3432 213.158 75.8599 212.766 74.5524 212.023L4.3011 172.028C2.99365 171.284 1.90788 170.215 1.15289 168.927C0.397907 167.639 0.000294807 166.178 4.81818e-06 164.691V84.6486C-0.00159396 83.1603 0.394717 81.6979 1.14906 80.4084C1.90341 79.1189 2.98919 78.0479 4.29716 77.303C5.60513 76.5582 7.08915 76.1659 8.59992 76.1655C10.1107 76.1651 11.5949 76.5566 12.9033 77.3008L31.8998 88.0489C33.2088 88.7934 34.2956 89.8646 35.0507 91.1545C35.8058 92.4445 36.2025 93.9076 36.2009 95.3967Z" fill="white"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M116.271 96.4669C117.641 94.0068 118.421 91.1735 118.421 88.158V75.7714C118.421 73.1654 116.308 71.0527 113.702 71.0527H110.526V65.1019C110.526 63.6485 109.348 62.4703 107.895 62.4703H94.7368C93.2834 62.4703 92.1052 63.6485 92.1052 65.1019V71.0527H88.9291C86.3231 71.0527 84.2104 73.1654 84.2104 75.7714V88.158C84.2104 91.1738 84.9909 94.0074 86.361 96.4677L63.9917 141.206C62.0418 145.106 63.6225 149.848 67.5223 151.798C71.4222 153.748 76.1643 152.167 78.1142 148.268L83.9616 136.573C84.044 136.593 84.1272 136.612 84.2113 136.632C87.4609 137.397 92.0262 138.158 97.3682 138.158C103.354 138.158 110.346 137.193 117.495 134.221L124.518 148.268C126.468 152.167 131.21 153.748 135.11 151.798C139.01 149.848 140.59 145.106 138.641 141.206L131.004 125.933C132.191 124.929 133.368 123.849 134.53 122.688C147.14 110.077 148.904 96.2192 147.276 85.6416C146.613 81.3322 142.582 78.3762 138.273 79.0391C133.964 79.7021 131.008 83.7331 131.671 88.0425C132.663 94.4951 131.827 102.885 123.653 111.231L116.271 96.4669ZM102.976 105.184L110.408 120.048C105.797 121.799 101.316 122.368 97.3682 122.368C95.1326 122.368 93.077 122.183 91.2878 121.92L99.6561 105.184C100.202 105.236 100.756 105.263 101.316 105.263C101.876 105.263 102.43 105.236 102.976 105.184ZM107.895 85.5264C107.895 89.1599 104.949 92.1054 101.316 92.1054C97.6823 92.1054 94.7368 89.1599 94.7368 85.5264C94.7368 81.893 97.6823 78.9475 101.316 78.9475C104.949 78.9475 107.895 81.893 107.895 85.5264Z" fill="white"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.1 KiB

8
mkdocs.yml
View File

@@ -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
@@ -60,3 +64,7 @@ markdown_extensions:
options:
custom_icons:
- docs/theme/.icons
extra_css:
- assets/extra.css
validation:
absolute_links: ignore

10
xml/types/AssetService.xml
View File

@@ -14,7 +14,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create new asset with the class name</Description>
</Methods>
<Methods>
<Name>NewPTImage</Name>
@@ -28,7 +28,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create new image from Polytoria with the target ID</Description>
</Methods>
<Methods>
<Name>NewPTAudio</Name>
@@ -42,7 +42,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create new audio from Polytoria with the target ID</Description>
</Methods>
<Methods>
<Name>NewPTMesh</Name>
@@ -56,10 +56,10 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create new mesh from Polytoria with the target ID</Description>
</Methods>
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Service for managing assets</Description>
</ClassDef>

2
xml/types/AudioAsset.xml
View File

@@ -5,5 +5,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>true</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Abstract class for audio</Description>
</ClassDef>

2
xml/types/BaseAsset.xml
View File

@@ -5,5 +5,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>true</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Base class for all assets</Description>
</ClassDef>

6
xml/types/BindableEvent.xml
View File

@@ -14,7 +14,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Invoke this event with parameters</Description>
</Methods>
<Events>
<Name>Invoked</Name>
@@ -22,10 +22,10 @@
<Name>...</Name>
<Type>any</Type>
</Arguments>
<Description>Fires when this bindable has been invoked</Description>
<Description>Fires when this event has been invoked</Description>
</Events>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>BindableEvent are events that can be called to communicate between scripts in the same boundary.</Description>
</ClassDef>

8
xml/types/BodyPosition.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the target position that the body applies forces to get to.</Description>
</Properties>
<Properties>
<Name>Force</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines how much force the body applies.</Description>
</Properties>
<Properties>
<Name>AcceptanceDistance</Name>
@@ -24,10 +24,10 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines how close the body has to be to the target position to stop applying forces to it.</Description>
</Properties>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>BodyPosition are objects that apply a force to their parent until it moves toward the target position.</Description>
</ClassDef>

4
xml/types/BoolValue.xml
View File

@@ -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>BoolValue is a ValueBase that stores a boolean.</Description>
</ClassDef>

4
xml/types/BuiltInAudioAsset.xml
View File

@@ -8,10 +8,10 @@
<IsAccessibleByScripts>false</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>The target audio to use</Description>
</Properties>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Audio asset that&apos;s built-in with the client</Description>
</ClassDef>

4
xml/types/BuiltInFontAsset.xml
View File

@@ -8,10 +8,10 @@
<IsAccessibleByScripts>false</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Target font to use</Description>
</Properties>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Font asset that&apos;s built-in with the client</Description>
</ClassDef>

64
xml/types/Camera.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines or returns the camera&apos;s current mode.</Description>
</Properties>
<Properties>
<Name>FOV</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines or returns the camera&apos;s field of view.</Description>
</Properties>
<Properties>
<Name>ClipThroughWalls</Name>
@@ -24,7 +24,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the camera should clip through walls.</Description>
</Properties>
<Properties>
<Name>MinDistance</Name>
@@ -32,7 +32,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>The camera&apos;s minimum distance from the player in Follow mode.</Description>
</Properties>
<Properties>
<Name>MaxDistance</Name>
@@ -40,7 +40,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines camera&apos;s maximum distance from the player in Follow mode.</Description>
</Properties>
<Properties>
<Name>Distance</Name>
@@ -48,7 +48,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the distance between the camera and the player when the camera is in Follow mode.</Description>
</Properties>
<Properties>
<Name>ScrollSensitivity</Name>
@@ -56,7 +56,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the scroll move speed of the camera.</Description>
</Properties>
<Properties>
<Name>Orthographic</Name>
@@ -64,7 +64,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the camera should render in orthographic (2D) mode or not (3D).</Description>
</Properties>
<Properties>
<Name>FollowLerp</Name>
@@ -72,7 +72,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not to use lerping in Follow mode.</Description>
</Properties>
<Properties>
<Name>LerpSpeed</Name>
@@ -80,7 +80,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the lerp speed of the camera when lerping is enabled.</Description>
</Properties>
<Properties>
<Name>OrthographicSize</Name>
@@ -88,7 +88,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the half-size of the camera when in orthographic mode.</Description>
</Properties>
<Properties>
<Name>PositionOffset</Name>
@@ -96,7 +96,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the camera&apos;s offset from its position.</Description>
</Properties>
<Properties>
<Name>RotationOffset</Name>
@@ -104,7 +104,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the camera&apos;s offset from its rotation.</Description>
</Properties>
<Properties>
<Name>IsFirstPerson</Name>
@@ -112,7 +112,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>true</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Returns whether or not the camera is in first person.</Description>
</Properties>
<Properties>
<Name>CanLock</Name>
@@ -120,7 +120,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine if camera can be ctrl locked.</Description>
</Properties>
<Properties>
<Name>SensitivityMultiplier</Name>
@@ -128,7 +128,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Multipler for camera sensitivity</Description>
</Properties>
<Properties>
<Name>Sensitivity</Name>
@@ -136,7 +136,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>true</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Current sensitivity of the camera</Description>
</Properties>
<Properties>
<Name>HorizontalSpeed</Name>
@@ -144,7 +144,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the horizontal movement speed of the camera in Follow mode.</Description>
</Properties>
<Properties>
<Name>VerticalSpeed</Name>
@@ -152,7 +152,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the vertical move speed of the camera.</Description>
</Properties>
<Properties>
<Name>ScrollLerpSpeed</Name>
@@ -160,7 +160,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines the lerp amount when scrolling</Description>
</Properties>
<Properties>
<Name>CtrlLocked</Name>
@@ -168,7 +168,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine if camera is in Ctrl lock mode</Description>
</Properties>
<Properties>
<Name>AlwaysLocked</Name>
@@ -176,7 +176,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine if camera should always be in locked mode</Description>
</Properties>
<Properties>
<Name>Target</Name>
@@ -184,7 +184,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>The target of Follow mode</Description>
</Properties>
<Methods>
<Name>ViewportPointToRay</Name>
@@ -210,7 +210,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>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</Description>
</Methods>
<Methods>
<Name>ScreenPointToRay</Name>
@@ -236,7 +236,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Cast a ray from the camera at screen point into the game world</Description>
</Methods>
<Methods>
<Name>ViewportToScreenPoint</Name>
@@ -250,7 +250,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from viewport space into screen space.</Description>
</Methods>
<Methods>
<Name>ViewportToWorldPoint</Name>
@@ -264,7 +264,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from viewport space into world space.</Description>
</Methods>
<Methods>
<Name>WorldToViewportPoint</Name>
@@ -278,7 +278,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from world space into viewport space.</Description>
</Methods>
<Methods>
<Name>WorldToScreenPoint</Name>
@@ -292,7 +292,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from world space into screen space.</Description>
</Methods>
<Methods>
<Name>ScreenToViewportPoint</Name>
@@ -306,7 +306,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from screen space into viewport space.</Description>
</Methods>
<Methods>
<Name>ScreenToWorldPoint</Name>
@@ -320,7 +320,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Transforms `pos` from screen space into world space.</Description>
</Methods>
<Events>
<Name>FirstPersonEntered</Name>
@@ -335,5 +335,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Camera is a class that represents the local player&apos;s camera.</Description>
</ClassDef>

14
xml/types/CaptureService.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>true</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Returns whenever the capture is on cooldown.</Description>
</Properties>
<Properties>
<Name>CanCapture</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines if user/scripts can take a picture.</Description>
</Properties>
<Properties>
<Name>DefaultCaptureOverlay</Name>
@@ -24,7 +24,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Default capture overlay for all captures</Description>
</Properties>
<Properties>
<Name>SpectatorAttach</Name>
@@ -32,7 +32,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Attaches a spectator camera at dynamic for use with spectator mode.</Description>
</Properties>
<Methods>
<Name>TakePhotoAtDynamic</Name>
@@ -58,7 +58,7 @@
<IsAsync>true</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Take a photo at dynamic</Description>
</Methods>
<Methods>
<Name>TakePhotoAt</Name>
@@ -90,10 +90,10 @@
<IsAsync>true</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>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.</Description>
</Methods>
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Service for capturing photos</Description>
</ClassDef>

6
xml/types/CharacterModel.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>The animator for this character</Description>
</Properties>
<Methods>
<Name>GetAttachment</Name>
@@ -22,10 +22,10 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Get attachment dynamic from this character</Description>
</Methods>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Base class for Character Models</Description>
</ClassDef>

6
xml/types/ChatService.xml
View File

@@ -14,7 +14,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Sends a chat message to all players.</Description>
</Methods>
<Methods>
<Name>UnicastMessage</Name>
@@ -34,7 +34,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
<Description>Missing Documentation</Description>
<Description>Sends a chat message to a specific player.</Description>
</Methods>
<Events>
<Name>NewChatMessage</Name>
@@ -59,5 +59,5 @@
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Chat is a static class used for various actions regarding the chat.</Description>
</ClassDef>

2
xml/types/ClientScript.xml
View File

@@ -5,5 +5,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>ClientScript is a script that runs locally for each player. It can only see what the player can see.</Description>
</ClassDef>

26
xml/types/Color.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Red color component</Description>
</Properties>
<Properties>
<Name>G</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Green color component</Description>
</Properties>
<Properties>
<Name>B</Name>
@@ -24,7 +24,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Blue color component</Description>
</Properties>
<Properties>
<Name>A</Name>
@@ -32,7 +32,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Alpha (opacity) color component</Description>
</Properties>
<Methods>
<Name>New</Name>
@@ -40,7 +40,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Creates a new black color.</Description>
</Methods>
<Methods>
<Name>New</Name>
@@ -54,7 +54,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Creates a new Color with an R, G and B value of `d`</Description>
</Methods>
<Methods>
<Name>New</Name>
@@ -80,7 +80,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Creates a new Color with the set R, G and B values and an alpha value of 1</Description>
</Methods>
<Methods>
<Name>New</Name>
@@ -112,7 +112,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Creates a new Color with the set R, G, B and A values</Description>
</Methods>
<Methods>
<Name>Random</Name>
@@ -120,7 +120,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Returns a random color with an alpha value of 1.</Description>
</Methods>
<Methods>
<Name>FromHex</Name>
@@ -134,7 +134,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Creates a new Color from the specified hex value.</Description>
</Methods>
<Methods>
<Name>Lerp</Name>
@@ -160,10 +160,12 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Linearly interpolates colors a and b by t.</Description>
</Methods>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>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.</Description>
</ClassDef>

10
xml/types/ColorAdjustModifier.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine the brightness adjustment</Description>
</Properties>
<Properties>
<Name>Contrast</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine the contrast adjustment</Description>
</Properties>
<Properties>
<Name>Saturation</Name>
@@ -24,7 +24,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine the saturation adjustment</Description>
</Properties>
<Properties>
<Name>TintColor</Name>
@@ -32,10 +32,10 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determine the tint color</Description>
</Properties>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>ColorAdjustModifier is a LightingModifier that allows the adjustment of lighting</Description>
</ClassDef>

8
xml/types/ColorSeries.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>true</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Returns the point count of this color series</Description>
</Properties>
<Methods>
<Name>New</Name>
@@ -16,7 +16,7 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create new color range with 2 default points</Description>
</Methods>
<Methods>
<Name>New</Name>
@@ -36,10 +36,10 @@
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>true</IsStatic>
<Description>Missing Documentation</Description>
<Description>Create color series by this color range</Description>
</Methods>
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Color series is a data type that represents a collection of color and points, also known as gradient.</Description>
</ClassDef>

4
xml/types/ColorValue.xml
View File

@@ -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>ColorValue is a ValueBase that stores a color.</Description>
</ClassDef>

18
xml/types/CoreUIService.xml
View File

@@ -8,7 +8,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the user card (in the upper right hand corner above the leaderboard) is visible.</Description>
</Properties>
<Properties>
<Name>UseChat</Name>
@@ -16,7 +16,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the chat box is visible.</Description>
</Properties>
<Properties>
<Name>UseHealthBar</Name>
@@ -24,7 +24,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the player's health bar is visible.</Description>
</Properties>
<Properties>
<Name>UseLeaderboard</Name>
@@ -32,7 +32,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the player list/leaderboard is visible.</Description>
</Properties>
<Properties>
<Name>UseHotbar</Name>
@@ -40,7 +40,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the hot bar is visible.</Description>
</Properties>
<Properties>
<Name>UseMenuButton</Name>
@@ -48,7 +48,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the menu button is visible.</Description>
</Properties>
<Properties>
<Name>UseEmoteWheel</Name>
@@ -56,7 +56,7 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the emote wheel is visible.</Description>
</Properties>
<Properties>
<Name>CanRespawn</Name>
@@ -64,10 +64,10 @@
<IsAccessibleByScripts>true</IsAccessibleByScripts>
<IsReadOnly>false</IsReadOnly>
<IsObsolete>false</IsObsolete>
<Description>Missing Documentation</Description>
<Description>Determines whether or not the player can respawn.</Description>
</Properties>
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CoreUI is a static class that allows for the toggling of certain core GUI.</Description>
</ClassDef>

2
xml/types/CreatorContextService.xml
View File

@@ -5,5 +5,5 @@
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CreatorContextService is a service that manage per game specific tools, such as Selections and History. This class is only available in the creator.</Description>
</ClassDef>

2
xml/types/CreatorGUI.xml
View File

@@ -5,5 +5,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>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.</Description>
</ClassDef>

2
xml/types/CreatorHistory.xml
View File

@@ -55,5 +55,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CreatorHistory is a class that manages history (undo-redo) of this game instance. This class is only available in the creator.</Description>
</ClassDef>

2
xml/types/CreatorInterface.xml
View File

@@ -77,5 +77,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CreatorInterface represent the user interface of the creator. This class is only available in the creator.</Description>
</ClassDef>

2
xml/types/CreatorSelections.xml
View File

@@ -183,5 +183,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CreatorSelections is an object that manages selections in the game instance. This class is only available in the creator.</Description>
</ClassDef>

2
xml/types/CreatorService.xml
View File

@@ -47,5 +47,5 @@
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>CreatorService is the class that manages the creator. This class is only available in the creator.</Description>
</ClassDef>

2
xml/types/Datastore.xml
View File

@@ -66,5 +66,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Datastore is an object that represent datastore connection.</Description>
</ClassDef>

2
xml/types/DatastoreService.xml
View File

@@ -19,5 +19,5 @@
<IsStatic>true</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>false</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Datastore (not to be confused with the Datastore data type) is a service used for storing data between place sessions.</Description>
</ClassDef>

2
xml/types/Decal.xml
View File

@@ -29,5 +29,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Decals are objects that can have an image texture and are wrapped around other objects.</Description>
</ClassDef>

4
xml/types/Dynamic.xml
View File

@@ -292,7 +292,7 @@
</Methods>
<Methods>
<Name>GetBounds</Name>
<ReturnType>Aabb</ReturnType>
<ReturnType>Bounds</ReturnType>
<IsAsync>false</IsAsync>
<IsObsolete>false</IsObsolete>
<IsStatic>false</IsStatic>
@@ -301,5 +301,5 @@
<IsStatic>false</IsStatic>
<IsAbstract>false</IsAbstract>
<IsInstantiatable>true</IsInstantiatable>
<Description>Missing Documentation</Description>
<Description>Dynamic is the base class where all objects with a position, rotation and scale derive from.</Description>
</ClassDef>