Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Script

An object that contains and runs Luau code on the server.

Memory categoryScript

Member index 2

HistoryMember
645Source: ProtectedString
462GetHash(): string
inherited from BaseScript
553Disabled: bool
553Enabled: bool
645LinkedSource: ContentId
566RunContext: RunContext
inherited from LuaSourceContainer
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: 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
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: 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()
657StyledPropertiesChanged()
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

A Script is a Luau source container that can access server-side objects, properties, and events, such as to award badges to players using BadgeService, while LocalScripts on the client cannot.

The instant that the following conditions are met, a script's code is run in a new thread:

The script will continue to run until the above conditions are not met, it terminates, or it raises an error (unless that error is raised by a function connected to some event that is firing). Additionally, the thread will be stopped if the script or one of its ancestors is destroyed. A script will continue to run even if the Parent property is set to nil and the Script is not destroyed.

History 13

  • 645 Change WriteSecurity of Source from PluginSecurity to None
  • 645 Change ReadSecurity of Source from PluginSecurity to None
  • 486 Change ThreadSafety of Source from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of GetHash from to Unsafe
  • 462 Change ThreadSafety of Source from to ReadOnly
  • 311 Change Security of GetHash from RobloxPlaceSecurity to LocalUserSecurity
  • 151 Change WriteSecurity of Source from security1 to PluginSecurity
  • 151 Change ReadSecurity of Source from security1 to PluginSecurity
  • 150 Change WriteSecurity of Source from LocalUserSecurity to security1
  • 150 Change ReadSecurity of Source from LocalUserSecurity to security1
  • 47 Add GetHash
  • 47 Add Source
  • 47 Add Script

Members 2

GetHash

Parameters (0)
No parameters.
Returns (1)
string
SecurityLocalUserSecurity
Thread safetyUnsafe

History 3

Source

TypeDefault
ProtectedString

Represents the code to be executed. It's protected and discouraged for editing directly. Attempting to access this property in a Script or LocalScript causes errors.

If you want to read or modify the source of a script that a user has open, use ScriptEditorService to interact with the Script Editor rather than directly modifying this property. Both ScriptEditorService:UpdateSourceAsync() and ScriptEditorService:GetEditorSource() can read or modify script content from the script editor if the script is opened. You can also read the source from the command line.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 9

  • 645 Change WriteSecurity of Source from PluginSecurity to None
  • 645 Change ReadSecurity of Source from PluginSecurity to None
  • 486 Change ThreadSafety of Source from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Source from to ReadOnly
  • 151 Change WriteSecurity of Source from security1 to PluginSecurity
  • 151 Change ReadSecurity of Source from security1 to PluginSecurity
  • 150 Change WriteSecurity of Source from LocalUserSecurity to security1
  • 150 Change ReadSecurity of Source from LocalUserSecurity to security1
  • 47 Add Source

Settings