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
553		Disabled: bool
553		Enabled: bool
645		LinkedSource: ContentId
566		RunContext: RunContext
8 members inherited from LuaSourceContainer
553		CachedRemoteSource: ProtectedString
553		CachedRemoteSourceLoadState: int
553		HasAssociatedDrafts: bool
553		IsDifferentFromFileSystem: bool
553		OriginalScriptGuid: string
553		SandboxedSource: ProtectedString
553		ScriptGuid: string
642		isPlayerScript: bool
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		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
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		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()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

The base class for all script objects which run automatically.

History 17
Hide member changes

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 will run or not.

If a script is disabled by changing this property to true while the script is running, the current running thread of the script will be terminated.

If this property is changed from true to false, the script will run again. This means that Disabled can be toggled to restart a script:

1 2	`scriptObject.Disabled = true scriptObject.Disabled = false`

Note that the above code snippet cannot be used within the script itself, since disabling the script from within itself will terminate the thread and the line to reenable it will never execute.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

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 will run or not. This should be used in favor of the similar but opposite Disabled property.

If a script is disabled by changing this property to false while the script is running, the current running thread of the script will be terminated.

If this property is changed from false to true, the script will run again. This means that Enabled can be toggled to restart a script:

1 2	`scriptObject.Enabled = false scriptObject.Enabled = true`

Note that the above code snippet cannot be used within the script itself, since disabling the script from within itself will terminate the thread and the line to reenable it will never execute.

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 2

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 6

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 will run.

When using the Legacy RunContext scripts will only run when parented to certain containers dependent on whether they are a Script or LocalScript.

If RunContext is assigned while the script is running any threads created by the script will be terminated and the script will start running under the new context if possible.

Note, RunContext cannot be used from a LocalScript.

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

History 3

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