diff --git a/content/common/navigation/engine/guides.yaml b/content/common/navigation/engine/guides.yaml index 9f5f79b45..b566a38c4 100644 --- a/content/common/navigation/engine/guides.yaml +++ b/content/common/navigation/engine/guides.yaml @@ -584,6 +584,16 @@ navigation: path: /cloud-services/extended-services - title: Cross-server communication path: /cloud-services/cross-server-messaging + - title: Roblox Standard Scripts + section: + - title: Overview + path: /roblox-scripts + - title: PlayerModule + section: + - title: Overview + path: /roblox-scripts/PlayerModule + - title: CameraModule + path: /roblox-scripts/PlayerModule/CameraModule - title: Roblox for Unity developers path: /unity - title: Roblox for Unreal developers diff --git a/content/en-us/assets/roblox-scripts/starterplayerscripts.png b/content/en-us/assets/roblox-scripts/starterplayerscripts.png new file mode 100644 index 000000000..c86a47fea Binary files /dev/null and b/content/en-us/assets/roblox-scripts/starterplayerscripts.png differ diff --git a/content/en-us/roblox-scripts/PlayerModule/CameraModule.md b/content/en-us/roblox-scripts/PlayerModule/CameraModule.md new file mode 100644 index 000000000..3832c8312 --- /dev/null +++ b/content/en-us/roblox-scripts/PlayerModule/CameraModule.md @@ -0,0 +1,29 @@ +--- +title: CameraModule +description: Overview about the CameraModule +--- + +This ModuleScript implements a singleton class to manage the selection, activation, and deactivation of the current camera controller, character occlusion controller, and transparency controller. This script binds to RenderStepped at Camera priority and calls the Update() methods on the active controller instances. + +The camera controller ModuleScripts implement classes which are instantiated and activated as-needed, they are no longer all instantiated up front as they were in the previous generation of PlayerScripts. + +## cameraRenderUpdate + +``cameraRenderUpdate`` is the RenderStep name used and bound with by the ``CameraModule`` with the priority ``Enum.RenderPriority.Camera.Value``, through Class.RunService:BindToRenderStep()|:BindToRenderStep(). + +For custom camera or other behavior, it is recommended to keep the **``Enum.RenderPriority``** in mind. The MicroProfiler can be used to debug which render steps are running in which order. + +The order is important. For instance, if the ``CameraModule`` changes the ``Datatype.CFrame`` of the camera, +you want to ensure that anything that's meant to change the ``Datatype.CFrame`` again runs first, before reading the ``Datatype.CFrame``, if you're expecting a different your custom modified values. + +``Class.RunService:BindToRenderStep()|:BindToRenderStep()`` runs before ``Class.RunService.RenderStep``. + +## MouseLockController + +### BoundKeys + +By default, the ``MouseLockController`` will create a ``Class.StringValue`` named ``BoundKeys``, placed under the module. By default it is set to ``"LeftShift,RightShift"`` with comma-separated values. They're named based off `Enum.KeyCode` and the values can be overwritten to change the bindings that should be used to trigger Mouse Lock (Shift-Lock). + +### CursorImage + +``CusorImage`` is a ``Class.StringValue`` that is placed under the module. The value by default contains ``rbxasset://textures/MouseLockedCursor.png`` and can be overwritten. It's not present until Mouse Lock is triggered for the first time, but any ``StringValue`` with the same name can be placed under the module to overwrite the image ahead. diff --git a/content/en-us/roblox-scripts/PlayerModule/index.md b/content/en-us/roblox-scripts/PlayerModule/index.md new file mode 100644 index 000000000..bf7b0fed2 --- /dev/null +++ b/content/en-us/roblox-scripts/PlayerModule/index.md @@ -0,0 +1,13 @@ +--- +title: Standard PlayerModule +description: Overview of the PlayerModule. +--- + +The ``PlayerModule`` is initialized by ``PlayerScriptsLoader``. +``PlayerScriptsLoader`` is a script which requires and instantiates the ``PlayerModule`` singleton. + +``PlayerModule`` comes with two further modules, [``CameraModule``](./CameraModule.md) and ``ControlModule``. + +## PlayerModule + +This module requires and instantiates the camera and control modules, and provides getters for developers to access methods on these singletons without having to modify Roblox-supplied scripts. diff --git a/content/en-us/roblox-scripts/index.md b/content/en-us/roblox-scripts/index.md new file mode 100644 index 000000000..26f5672ae --- /dev/null +++ b/content/en-us/roblox-scripts/index.md @@ -0,0 +1,14 @@ +--- +title: Roblox Standard Scripts +description: Overview of Roblox Standard Scripts +--- + +By default, Roblox creates default scripts that provide behavior for things such as the Camera and Character Controls. + +
+Showcase of some standard Roblox Scripts. +
+ +By starting a playtest F5, you can find the inserted scripts and copy them through the Explorer, and then stop the playtest and paste the scripts in, in order to optionally modify them, if preferred. + +These standard scripts can be overwritten by placing an Instance with the same name, located at the same path.