Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PlayerScripts

A container for LocalScripts to be run on the client.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable, NotReplicated]

Member index 16

HistoryMember
573ClearComputerCameraMovementModes(): null
573ClearComputerMovementModes(): null
573ClearTouchCameraMovementModes(): null
573ClearTouchMovementModes(): null
462GetRegisteredComputerCameraMovementModes(): Array
462GetRegisteredComputerMovementModes(): Array
462GetRegisteredTouchCameraMovementModes(): Array
462GetRegisteredTouchMovementModes(): Array
573RegisterComputerCameraMovementMode(cameraMovementMode: ComputerCameraMovementMode): null
573RegisterComputerMovementMode(movementMode: ComputerMovementMode): null
573RegisterTouchCameraMovementMode(cameraMovementMode: TouchCameraMovementMode): null
573RegisterTouchMovementMode(movementMode: TouchMovementMode): null
462ComputerCameraMovementModeRegistered()
462ComputerMovementModeRegistered()
462TouchCameraMovementModeRegistered()
462TouchMovementModeRegistered()
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

PlayerScripts is a container object located inside Player objects within the Players game service. It is created automatically when a player joins the game. Its main purpose is to contain LocalScripts copied from the StarterPlayerScripts container within the StarterPlayer game service, which happens once upon creation. Descendant LocalScripts of PlayerScripts will run code on the client of the Player.

Unlike the Backpack and PlayerGui containers, the PlayerScripts container is not accessible to the server. Server Script objects will not run when parented to PlayerScripts.

History 45

Members 16

ClearComputerCameraMovementModes

Parameters (0)
No parameters.
Returns (1)
null

Unregisters all ComputerCameraMovementMode enums from the game settings menu.

History 3

ClearComputerMovementModes

Parameters (0)
No parameters.
Returns (1)
null

Unregisters all ComputerMovementMode enums from the game settings menu.

History 3

ClearTouchCameraMovementModes

Parameters (0)
No parameters.
Returns (1)
null

Unregisters all TouchCameraMovementMode enums from the game settings menu.

History 3

ClearTouchMovementModes

Parameters (0)
No parameters.
Returns (1)
null

Unregisters all TouchMovementMode enums from the game settings menu.

History 3

ComputerCameraMovementModeRegistered

Parameters (0)
No parameters.

History 3

ComputerMovementModeRegistered

Parameters (0)
No parameters.

History 3

GetRegisteredComputerCameraMovementModes

Parameters (0)
No parameters.
Returns (1)
Array

History 2

GetRegisteredComputerMovementModes

Parameters (0)
No parameters.
Returns (1)
Array

History 2

GetRegisteredTouchCameraMovementModes

Parameters (0)
No parameters.
Returns (1)
Array

History 2

GetRegisteredTouchMovementModes

Parameters (0)
No parameters.
Returns (1)
Array

History 2

RegisterComputerCameraMovementMode

Parameters (1)
cameraMovementModeComputerCameraMovementMode
Returns (1)
null

Registers that a computer camera movement mode is available to be selected from the game menu.

History 3

RegisterComputerMovementMode

Parameters (1)
movementModeComputerMovementMode
Returns (1)
null

Registers that a computer movement mode is available to be selected from the game menu.

History 3

RegisterTouchCameraMovementMode

Parameters (1)
cameraMovementModeTouchCameraMovementMode
Returns (1)
null

Registers that a touch camera movement mode is available to be selected from the game menu.

History 3

RegisterTouchMovementMode

Parameters (1)
movementModeTouchMovementMode
Returns (1)
null

Registers that a touch movement mode is available to be selected from the game menu.

History 3

TouchCameraMovementModeRegistered

Parameters (0)
No parameters.

History 3

TouchMovementModeRegistered

Parameters (0)
No parameters.

History 3

Settings