PlayerScripts
| Memory category | Instances |
|---|
Member index 16
Description
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.
History 45
- 573 Change ReturnType of RegisterTouchMovementMode from void to null
- 573 Change ReturnType of RegisterTouchCameraMovementMode from void to null
- 573 Change ReturnType of RegisterComputerMovementMode from void to null
- 573 Change ReturnType of RegisterComputerCameraMovementMode from void to null
- 573 Change ReturnType of ClearTouchMovementModes from void to null
- 573 Change ReturnType of ClearTouchCameraMovementModes from void to null
- 573 Change ReturnType of ClearComputerMovementModes from void to null
- 573 Change ReturnType of ClearComputerCameraMovementModes from void to null
- 462 Change ThreadSafety of TouchMovementModeRegistered from to Unsafe
- 462 Change ThreadSafety of TouchCameraMovementModeRegistered from to Unsafe
- 462 Change ThreadSafety of ComputerMovementModeRegistered from to Unsafe
- 462 Change ThreadSafety of ComputerCameraMovementModeRegistered from to Unsafe
- 462 Change ThreadSafety of RegisterTouchMovementMode from to Unsafe
- 462 Change ThreadSafety of RegisterTouchCameraMovementMode from to Unsafe
- 462 Change ThreadSafety of RegisterComputerMovementMode from to Unsafe
- 462 Change ThreadSafety of RegisterComputerCameraMovementMode from to Unsafe
- 462 Change ThreadSafety of GetRegisteredTouchMovementModes from to Unsafe
- 462 Change ThreadSafety of GetRegisteredTouchCameraMovementModes from to Unsafe
- 462 Change ThreadSafety of GetRegisteredComputerMovementModes from to Unsafe
- 462 Change ThreadSafety of GetRegisteredComputerCameraMovementModes from to Unsafe
- 462 Change ThreadSafety of ClearTouchMovementModes from to Unsafe
- 462 Change ThreadSafety of ClearTouchCameraMovementModes from to Unsafe
- 462 Change ThreadSafety of ClearComputerMovementModes from to Unsafe
- 462 Change ThreadSafety of ClearComputerCameraMovementModes from to Unsafe
- 309 Change Parameters of TouchMovementModeRegistered from (movementMode: TouchMovementMode) to ()
- 309 Change Parameters of TouchCameraMovementModeRegistered from (movementMode: TouchCameraMovementMode) to ()
- 309 Change Parameters of ComputerMovementModeRegistered from (movementMode: ComputerMovementMode) to ()
- 309 Change Parameters of ComputerCameraMovementModeRegistered from (movementMode: ComputerCameraMovementMode) to ()
- 309 Add ClearTouchMovementModes
- 309 Add ClearTouchCameraMovementModes
- 309 Add ClearComputerMovementModes
- 309 Add ClearComputerCameraMovementModes
- 301 Add TouchMovementModeRegistered
- 301 Add TouchCameraMovementModeRegistered
- 301 Add ComputerMovementModeRegistered
- 301 Add ComputerCameraMovementModeRegistered
- 301 Add RegisterTouchMovementMode
- 301 Add RegisterTouchCameraMovementMode
- 301 Add RegisterComputerMovementMode
- 301 Add RegisterComputerCameraMovementMode
- 301 Add GetRegisteredTouchMovementModes
- 301 Add GetRegisteredTouchCameraMovementModes
- 301 Add GetRegisteredComputerMovementModes
- 301 Add GetRegisteredComputerCameraMovementModes
- 176 Add PlayerScripts
Members 16
ClearComputerCameraMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ClearComputerCameraMovementModes from void to null
- 462 Change ThreadSafety of ClearComputerCameraMovementModes from to Unsafe
- 309 Add ClearComputerCameraMovementModes
ClearComputerMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ClearComputerMovementModes from void to null
- 462 Change ThreadSafety of ClearComputerMovementModes from to Unsafe
- 309 Add ClearComputerMovementModes
ClearTouchCameraMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ClearTouchCameraMovementModes from void to null
- 462 Change ThreadSafety of ClearTouchCameraMovementModes from to Unsafe
- 309 Add ClearTouchCameraMovementModes
ClearTouchMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ClearTouchMovementModes from void to null
- 462 Change ThreadSafety of ClearTouchMovementModes from to Unsafe
- 309 Add ClearTouchMovementModes
ComputerCameraMovementModeRegistered
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of ComputerCameraMovementModeRegistered from to Unsafe
- 309 Change Parameters of ComputerCameraMovementModeRegistered from (movementMode: ComputerCameraMovementMode) to ()
- 301 Add ComputerCameraMovementModeRegistered
ComputerMovementModeRegistered
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of ComputerMovementModeRegistered from to Unsafe
- 309 Change Parameters of ComputerMovementModeRegistered from (movementMode: ComputerMovementMode) to ()
- 301 Add ComputerMovementModeRegistered
GetRegisteredComputerCameraMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetRegisteredComputerCameraMovementModes from to Unsafe
- 301 Add GetRegisteredComputerCameraMovementModes
GetRegisteredComputerMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetRegisteredComputerMovementModes from to Unsafe
- 301 Add GetRegisteredComputerMovementModes
GetRegisteredTouchCameraMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetRegisteredTouchCameraMovementModes from to Unsafe
- 301 Add GetRegisteredTouchCameraMovementModes
GetRegisteredTouchMovementModes
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetRegisteredTouchMovementModes from to Unsafe
- 301 Add GetRegisteredTouchMovementModes
RegisterComputerCameraMovementMode
| Parameters (1) | ||
|---|---|---|
| cameraMovementMode | ComputerCameraMovementMode | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RegisterComputerCameraMovementMode from void to null
- 462 Change ThreadSafety of RegisterComputerCameraMovementMode from to Unsafe
- 301 Add RegisterComputerCameraMovementMode
RegisterComputerMovementMode
| Parameters (1) | ||
|---|---|---|
| movementMode | ComputerMovementMode | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RegisterComputerMovementMode from void to null
- 462 Change ThreadSafety of RegisterComputerMovementMode from to Unsafe
- 301 Add RegisterComputerMovementMode
RegisterTouchCameraMovementMode
| Parameters (1) | ||
|---|---|---|
| cameraMovementMode | TouchCameraMovementMode | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RegisterTouchCameraMovementMode from void to null
- 462 Change ThreadSafety of RegisterTouchCameraMovementMode from to Unsafe
- 301 Add RegisterTouchCameraMovementMode
RegisterTouchMovementMode
| Parameters (1) | ||
|---|---|---|
| movementMode | TouchMovementMode | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RegisterTouchMovementMode from void to null
- 462 Change ThreadSafety of RegisterTouchMovementMode from to Unsafe
- 301 Add RegisterTouchMovementMode
TouchCameraMovementModeRegistered
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of TouchCameraMovementModeRegistered from to Unsafe
- 309 Change Parameters of TouchCameraMovementModeRegistered from (movementMode: TouchCameraMovementMode) to ()
- 301 Add TouchCameraMovementModeRegistered
TouchMovementModeRegistered
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of TouchMovementModeRegistered from to Unsafe
- 309 Change Parameters of TouchMovementModeRegistered from (movementMode: TouchMovementMode) to ()
- 301 Add TouchMovementModeRegistered