Reference API Roblox

Engine API

Website

Related

Reference API Roblox

StarterPlayerScripts

A container for objects to be copied to a Player's PlayerScripts when they join a game.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 0

HistoryMember
No members defined by StarterPlayerScripts.
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
486GetChildren(): Objects
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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
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
647isA(className: string): bool
647Changed(property: string)

Description

StarterPlayerScripts is a container object located within the StarterPlayer service. It can contain LocalScripts and other objects to be copied to the PlayerScripts container once when a Player joins the game. For example, if you want to create special effects on the client when certain conditions are met, you can place a LocalScript within this container to do that.

This object is also a good place for LocalScripts that define additional inputs with ContextActionService. For inputs that are only relevant when a player has spawned in, you can use ContextActionService:BindAction() when the Players.LocalPlayer character spawns, then use ContextActionService:UnbindAction() when they die or despawn.

When an experience is run, this object will also house the default multi-platform Roblox control scripts for the camera and character. If LocalScripts named CameraScript or ControlScript are placed within this container, they will replace the Roblox defaults for those scripts respectively. If desired, you can add empty LocalScripts for each of these to disable them altogether; this is useful for experiences that do not follow the typical control paradigms of a Roblox experience.

History 4

Settings