From 14ba19308478402a176539003a9dc4c41e3161e8 Mon Sep 17 00:00:00 2001 From: randomgithubaccount19837 <166883639+randomgithubaccount19837@users.noreply.github.com> Date: Tue, 24 Feb 2026 18:52:20 +0700 Subject: [PATCH 1/4] Fix CameraMode docs --- docs/objects/enums/CameraMode.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/objects/enums/CameraMode.md b/docs/objects/enums/CameraMode.md index 33c0e4d6..d05bf9ff 100644 --- a/docs/objects/enums/CameraMode.md +++ b/docs/objects/enums/CameraMode.md @@ -10,4 +10,5 @@ icon: polytoria/Enum | ------------------------- | ----------------------------------------------- | | `CameraMode.Scripted` | Camera is able to be controlled by scripts | | `CameraMode.FollowPlayer` | Camera is controlled by the player `(default)` | -| `CameraMode.FreeCam` | Camera is able to be freely moved by the player | +| `CameraMode.Free` | Camera is able to be freely moved by the player | +| `CameraMode.FollowTarget` | Camera follows a DynamicInstance | From 666511b425e00adbc6e92a333d099f6b92afbdde Mon Sep 17 00:00:00 2001 From: randomgithubaccount19837 <166883639+randomgithubaccount19837@users.noreply.github.com> Date: Tue, 24 Feb 2026 18:53:39 +0700 Subject: [PATCH 2/4] Fix Input.md and document GetMouseWorldPoint May not be accurate. --- docs/objects/static-classes/Input.md | 43 +++++++++++++--------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/docs/objects/static-classes/Input.md b/docs/objects/static-classes/Input.md index 20d795aa..de0762c2 100644 --- a/docs/objects/static-classes/Input.md +++ b/docs/objects/static-classes/Input.md @@ -12,45 +12,38 @@ icon: polytoria/Input ## Events -### KeyDown(key;string) { event } +### KeyDown(key;number) { event } -Fires when a key is pressed. +Fires when a key is pressed. Uses an Unity key value. **Example** ```lua Input.KeyDown:Connect(function (key) - print(key .. " was pressed!") + print(tostring(key) .. " was pressed!") - if key == "P" then + if key == 112 then print("The 'P' key was pressed!") end end) ``` -### KeyUp(key;string) { event } +### KeyUp(key;number) { event } -Fires when a key is released. +Fires when a key is released. Also uses an Unity key value. ```lua Input.KeyUp:Connect(function (key) - print(key .. " was pressed!") + print(tostring(key) .. " was released!") - if key == "P" then - print("The 'P' key was pressed!") + if key == 112 then + print("The 'P' key was released!") end end) ``` ## Methods -
-!!! danger "Undocumented Methods" - - This section is a work in progress! The method `GetMouseWorldPoint` is not written yet. Want to contribute? Go to the GitHub and open a pull request [here](https://github.com/Polytoria/Docs)! - -
- ### GetAxis(axisName;string):float { method } Returns the value of the specified axis. @@ -71,17 +64,17 @@ Returns `true` during the frame in which the specified button was pressed. Returns `true` during the frame in which the specified button was released. -### GetKey(keyName;string):bool { method } +### GetKey(keyValue;number):bool { method } -Returns `true` if the specified key is being held down. +Returns `true` if the specified key is being held down. Uses an Unity key value. -### GetKeyDown(keyName;string):bool { method } +### GetKeyDown(keyValue;number):bool { method } -Returns `true` during the frame in which the specified key was pressed. +Returns `true` during the frame in which the specified key was pressed. Uses an Unity key value. -### GetKeyUp(keyName;string):bool { method } +### GetKeyUp(keyValue;number):bool { method } -Returns `true` during the frame in which the specified key was released. +Returns `true` during the frame in which the specified key was released. Uses an Unity key value. ### GetMouseButton(mouseButton;int):bool { method } @@ -99,13 +92,17 @@ Returns `true` during the frame in which the specified mouse button was released Returns the 3D world-space position corresponding to the current mouse cursor location. +### GetMouseWorldPoint:Vector3 { method } + +Returns the 3D world-space position corresponding to the current mouse cursor location relative to the camera. + ### ScreenPointToRay(position;Vector3, List ignoreList = null):RayResult { method } Cast a ray from the camera at screen point into the game world ### ViewportPointToRay(position;Vector3, List ignoreList = null):RayResult { method } -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 +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 the right and to the top of the screen) into the game world ### ScreenToViewportPoint(screenPosition;Vector3):Vector3 { method } From fae1e1a269c5503b73c03436f3286043ca1ee1ee Mon Sep 17 00:00:00 2001 From: randomgithubaccount19837 <166883639+randomgithubaccount19837@users.noreply.github.com> Date: Tue, 24 Feb 2026 19:02:44 +0700 Subject: [PATCH 3/4] so it turns out they fixed the GetKey and all related methods --- docs/objects/static-classes/Input.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/objects/static-classes/Input.md b/docs/objects/static-classes/Input.md index de0762c2..ee9f885d 100644 --- a/docs/objects/static-classes/Input.md +++ b/docs/objects/static-classes/Input.md @@ -12,31 +12,31 @@ icon: polytoria/Input ## Events -### KeyDown(key;number) { event } +### KeyDown(key;string) { event } -Fires when a key is pressed. Uses an Unity key value. +Fires when a key is pressed. **Example** ```lua Input.KeyDown:Connect(function (key) - print(tostring(key) .. " was pressed!") + print(key .. " was pressed!") - if key == 112 then + if key == "P" then print("The 'P' key was pressed!") end end) ``` -### KeyUp(key;number) { event } +### KeyUp(key;string) { event } Fires when a key is released. Also uses an Unity key value. ```lua Input.KeyUp:Connect(function (key) - print(tostring(key) .. " was released!") + print(key .. " was released!") - if key == 112 then + if key == "P" then print("The 'P' key was released!") end end) @@ -64,15 +64,15 @@ Returns `true` during the frame in which the specified button was pressed. Returns `true` during the frame in which the specified button was released. -### GetKey(keyValue;number):bool { method } +### GetKey(keyName;String):bool { method } -Returns `true` if the specified key is being held down. Uses an Unity key value. +Returns `true` if the specified key is being held down. -### GetKeyDown(keyValue;number):bool { method } +### GetKeyDown(keyName;string):bool { method } -Returns `true` during the frame in which the specified key was pressed. Uses an Unity key value. +Returns `true` during the frame in which the specified key was pressed. -### GetKeyUp(keyValue;number):bool { method } +### GetKeyUp(keyName;string):bool { method } Returns `true` during the frame in which the specified key was released. Uses an Unity key value. From af818ab43f292935762c53950bc43882a62fb949 Mon Sep 17 00:00:00 2001 From: randomgithubaccount19837 <166883639+randomgithubaccount19837@users.noreply.github.com> Date: Tue, 24 Feb 2026 19:04:51 +0700 Subject: [PATCH 4/4] fix capitalization --- docs/objects/static-classes/Input.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/objects/static-classes/Input.md b/docs/objects/static-classes/Input.md index ee9f885d..a3463a32 100644 --- a/docs/objects/static-classes/Input.md +++ b/docs/objects/static-classes/Input.md @@ -64,7 +64,7 @@ Returns `true` during the frame in which the specified button was pressed. Returns `true` during the frame in which the specified button was released. -### GetKey(keyName;String):bool { method } +### GetKey(keyName;string):bool { method } Returns `true` if the specified key is being held down.