RBX.lua.Script (Object)

Up one category:
Class reference

A Script in Roblox is a type of object that hold a section of Lua code. A script will execute on server and has access only to server-side events and properties. See Hopperbins for the exception.

A Script runs when placed as a Descendant of any of the following (and not Disabled):

• Workspace
• Backpack
• PlayerGui

Note: Changing the value of Disabled will have no effect unless script parent is subsequently changed.

Functions

The Script object only incorporates the global functions.

Properties

In addition to the Global properties, the Script also has these:

• Disabled
• LinkedSource
• Source

Events

The Script object only incorporates the global events.

Up one category:
Class reference

Script (extends BaseScript) method GetHash method Clone method FindFirstChild method GetChildren method GetDebugId method GetFullName method IsA method IsAncestorOf method IsDescendantOf method Destroy method ClearAllChildren property Source property Disabled property LinkedSource property Name property Parent property Archivable property ClassName property RobloxLocked property DataCost event AncestryChanged event Changed event ChildAdded event ChildRemoved event DescendantAdded event DescendantRemoving

A Script in Roblox is a type of object that hold a section of Lua code. A script will execute on server and has access only to server-side events and properties. See Hopperbins for the exception.

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Remove( )
Returns	nil
Description:	Sets the Parent property to nil and calls Remove() on all children.
Member of:	Instance

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

Disabled
Property	Bool disabled
Description	Sets whether the object works or not.
Member of	BaseScript

LinkedSource
Type	Content
Description	URL that points to an online script source. Binds the online code to the script's Source.
Member of	BaseScript

Source
Property	ProtectedString Source
Description	The code of a script. It is neither readable nor writable from scripts.
Member of	Script

Source
Property	CustomEvent Source
Description	Attaches the Receiver object to a CustomEvent.
Member of	CustomEventReceiver

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance