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 | diff --git a/docs/objects/static-classes/Input.md b/docs/objects/static-classes/Input.md index 20d795aa..a3463a32 100644 --- a/docs/objects/static-classes/Input.md +++ b/docs/objects/static-classes/Input.md @@ -30,27 +30,20 @@ end) ### KeyUp(key;string) { 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(key .. " was released!") if key == "P" then - print("The 'P' key was pressed!") + 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. @@ -81,7 +74,7 @@ Returns `true` during the frame in which the specified key was pressed. ### GetKeyUp(keyName;string):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 }