BaseScript
CreatorHub

The base class for all script objects which run automatically.

Instances of this class cannot be created with Instance.new.

Memory category	Script

Tags: [NotCreatable]

Member index 4

History		Member
731		Disabled: bool
731		Enabled: bool
731		LinkedSource: ContentId
731		RunContext: RunContext
7 members inherited from LuaSourceContainer
731		CachedRemoteSource: ProtectedString
731		CachedRemoteSourceLoadState: int
731		HasAssociatedDrafts: bool
731		IsDifferentFromFileSystem: bool
731		SandboxedSource: ProtectedString
731		ScriptGuid: string
731		isPlayerScript: bool
68 members inherited from Instance
731		Archivable: bool
731		Attributes: string
731		AttributesReplicate: string
731		AttributesSerialize: BinaryString
731		Capabilities: SecurityCapabilities
731		DataCost: int
731		DefinesCapabilities: bool
731		HistoryId: UniqueId
731		IsInSandbox: bool
731		Name: string
731		Parent: Instance
731		PredictionMode: PredictionMode
731		PropertyStatusStudio: PropertyStatus
731		RobloxLocked: bool
731		Sandboxed: bool
731		SourceAssetId: int64
731		Tags: SharedString
731		UniqueId: UniqueId
731		archivable: bool
731		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
731		children(): Instances
731		clone(): Instance
731		destroy(): null
731		findFirstChild(name: string, recursive: bool = false): Instance
731		getChildren(): Instances
731		isDescendantOf(ancestor: Instance): bool
731		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
731		childAdded(child: Instance)
6 members inherited from Object
731		ClassName: string
731		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
731		isA(className: string): bool
647		Changed(property: string)

Description

The base class for all script objects which run automatically.

History 25
Hide member changes

731 Change Default of RunContext from to
731 Change Default of LinkedSource from to
731 Change Default of Enabled from to
731 Change Default of Disabled from to
726 Change Default of RunContext from to
726 Change Default of LinkedSource from to
726 Change Default of Enabled from to
726 Change Default of Disabled from to
645 Change ValueType of LinkedSource from Content to ContentId
614 Change Tags of LinkedSource from [] to [Deprecated]
566 Change ReadSecurity of RunContext from PluginSecurity to None
553 Change Default of RunContext from to
553 Change Default of LinkedSource from to
553 Change Default of Enabled from to
553 Change Default of Disabled from to
542 Add Enabled
534 Add RunContext
486 Change ThreadSafety of LinkedSource from ReadOnly to ReadSafe
486 Change ThreadSafety of Disabled from ReadOnly to ReadSafe
462 Change ThreadSafety of LinkedSource from to ReadOnly
462 Change ThreadSafety of Disabled from to ReadOnly
187 Change Superclass of BaseScript from Instance to LuaSourceContainer
47 Add LinkedSource
47 Add Disabled
47 Add BaseScript

Members 4

Disabled
CreatorHub

Type		Default
bool

Determines whether a BaseScript runs or not.

Setting this property to true while the script is running drops its references to the script's thread; a thread that is yielded (or that yields later) is never resumed and becomes eligible for garbage collection. A thread that is actively executing continues to run until it next yields or returns.

If this property is changed from true to false, a fresh run of the script is started. This means that Disabled can be toggled to restart a script.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 6

731 Change Default of Disabled from to
726 Change Default of Disabled from to
553 Change Default of Disabled from to
486 Change ThreadSafety of Disabled from ReadOnly to ReadSafe
462 Change ThreadSafety of Disabled from to ReadOnly
47 Add Disabled

Enabled
CreatorHub

Type		Default
bool

Determines whether a BaseScript runs or not. We recommend this property over the similar but opposite Disabled.

Setting this property to false while the script is running drops its references to the script's thread; a thread that is yielded (or that yields later) is never resumed and becomes eligible for garbage collection. A thread that is actively executing continues to run until it next yields or returns.

If this property is changed from false to true, a fresh run of the script is started. This means that Enabled can be toggled to restart a script.

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 4

731 Change Default of Enabled from to
726 Change Default of Enabled from to
553 Change Default of Enabled from to
542 Add Enabled

Tags: [NotReplicated]

LinkedSource
CreatorHub

Type		Default
ContentId

The content ID of an uploaded script. When set binds the uploaded code to the script's Script.Source.

By default, this property is set to '[Embedded]'. This means the source of the script is not linked to an upload script and is instead written in the script.

1	`script.LinkedSource = "http://www.roblox.com/asset/?id=1014476" -- link source`

Developers should remove a linked source via the properties window, rather than setting the property to '[Embedded]'.

For the LinkedSource property for ModuleScripts, please see ModuleScript.LinkedSource.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 8

731 Change Default of LinkedSource from to
726 Change Default of LinkedSource from to
645 Change ValueType of LinkedSource from Content to ContentId
614 Change Tags of LinkedSource from [] to [Deprecated]
553 Change Default of LinkedSource from to
486 Change ThreadSafety of LinkedSource from ReadOnly to ReadSafe
462 Change ThreadSafety of LinkedSource from to ReadOnly
47 Add LinkedSource

Tags: [Deprecated]

RunContext
CreatorHub

Type		Default
RunContext

Determines the context under which the script runs. Only available for Scripts, not LocalScripts.

When set to Legacy, Scripts only run when parented to certain containers. See Script types and locations.

If RunContext is assigned while the script is running, the engine drops its references to that thread, and a fresh run of the script is started under the new context (if possible). A thread that is actively executing continues to run until it next yields or returns.

Write security	PluginSecurity
Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 5

731 Change Default of RunContext from to
726 Change Default of RunContext from to
566 Change ReadSecurity of RunContext from PluginSecurity to None
553 Change Default of RunContext from to
534 Add RunContext

Reference API Roblox

Engine API

Website

Related