Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PlayerScripts
Inherits from: Instance → Object
PlayerScripts is a container object located inside Player objects within the Players service. It is created automatically when a player joins the game and its main purpose is to contain client scripts copied from the StarterPlayerScripts container within the StarterPlayer service.
Unlike the Backpack and PlayerGui containers, the PlayerScripts container is not accessible to the server and server‑side Script objects will not run when parented to PlayerScripts.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, NotReplicated
Methods
| Name | Type / Returns | Description |
|---|---|---|
| PlayerScripts:ClearComputerCameraMovementModes | () | Unregisters all ComputerCameraMovementMode enums from the game's settings menu. |
| PlayerScripts:ClearComputerMovementModes | () | Unregisters all ComputerMovementMode enums from the game's settings menu. |
| PlayerScripts:ClearTouchCameraMovementModes | () | Unregisters all TouchCameraMovementMode enums from the game's settings menu. |
| PlayerScripts:ClearTouchMovementModes | () | Unregisters all TouchMovementMode enums from the game's settings menu. |
| PlayerScripts:RegisterComputerCameraMovementMode | () | Registers that a computer camera movement mode is available to be selected from the game menu. |
| PlayerScripts:RegisterComputerMovementMode | () | Registers that a computer movement mode is available to be selected from the game menu. |
| PlayerScripts:RegisterTouchCameraMovementMode | () | Registers that a touch camera movement mode is available to be selected from the game menu. |
| PlayerScripts:RegisterTouchMovementMode | () | Registers that a touch movement mode is available to be selected from the game menu. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
PlayerScripts:ClearComputerCameraMovementModes
Removes every ComputerCameraMovementMode currently registered on this PlayerScripts instance, so the in-experience settings menu offers no computer camera modes until one is registered again with PlayerScripts:RegisterComputerCameraMovementMode(). The call always notifies the settings menu, which rebuilds its camera-mode options to reflect the now-empty set.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:ClearComputerMovementModes
Removes every ComputerMovementMode currently registered on this PlayerScripts instance, so the in-experience settings menu offers no computer movement modes until one is registered again with PlayerScripts:RegisterComputerMovementMode(). The call always notifies the settings menu, which rebuilds its movement-mode options to reflect the now-empty set.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:ClearTouchCameraMovementModes
Removes every TouchCameraMovementMode currently registered on this PlayerScripts instance, so the in-experience settings menu offers no touch camera modes until one is registered again with PlayerScripts:RegisterTouchCameraMovementMode(). The call always notifies the settings menu, which rebuilds its camera-mode options to reflect the now-empty set.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:ClearTouchMovementModes
Removes every TouchMovementMode currently registered on this PlayerScripts instance, so the in-experience settings menu offers no touch movement modes until one is registered again with PlayerScripts:RegisterTouchMovementMode(). The call always notifies the settings menu, which rebuilds its movement-mode options to reflect the now-empty set.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:RegisterComputerCameraMovementMode
Adds cameraMovementMode to the set of ComputerCameraMovementMode options a player can select in the in-experience settings menu on mouse-and-keyboard devices. A new PlayerScripts instance is pre-populated with the default computer camera modes (ComputerCameraMovementMode.Default, ComputerCameraMovementMode.Classic, and ComputerCameraMovementMode.Follow); the first call to this method clears that default set so that only the modes you explicitly register are offered, and each later call adds one more. Registering a mode notifies the settings menu so its list of camera options updates.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| cameraMovementMode | ComputerCameraMovementMode | The ComputerCameraMovementMode to add to the selectable options in the settings menu. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:RegisterComputerMovementMode
Adds movementMode to the set of ComputerMovementMode options a player can select in the in-experience settings menu on mouse-and-keyboard devices. A new PlayerScripts instance is pre-populated with the default computer movement modes (ComputerMovementMode.Default, ComputerMovementMode.KeyboardMouse, and ComputerMovementMode.ClickToMove); the first call to this method clears that default set so that only the modes you explicitly register are offered, and each later call adds one more. Registering a mode notifies the settings menu so its list of movement options updates.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| movementMode | ComputerMovementMode | The ComputerMovementMode to add to the selectable options in the settings menu. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:RegisterTouchCameraMovementMode
Adds cameraMovementMode to the set of TouchCameraMovementMode options a player can select in the in-experience settings menu on touch devices. A new PlayerScripts instance is pre-populated with the default touch camera modes (TouchCameraMovementMode.Default, TouchCameraMovementMode.Classic, and TouchCameraMovementMode.Follow); the first call to this method clears that default set so that only the modes you explicitly register are offered, and each later call adds one more. Registering a mode notifies the settings menu so its list of camera options updates.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| cameraMovementMode | TouchCameraMovementMode | The TouchCameraMovementMode to add to the selectable options in the settings menu. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
PlayerScripts:RegisterTouchMovementMode
Adds movementMode to the set of TouchMovementMode options a player can select in the in-experience settings menu on touch devices. A new PlayerScripts instance is pre-populated with the default touch movement modes (TouchMovementMode.Default, TouchMovementMode.Thumbstick, TouchMovementMode.ClickToMove, and TouchMovementMode.DynamicThumbstick); the first call to this method clears that default set so that only the modes you explicitly register are offered, and each later call adds one more. Registering a mode notifies the settings menu so its list of movement options updates.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| movementMode | TouchMovementMode | The TouchMovementMode to add to the selectable options in the settings menu. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input","Players"] |
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |