RBX.lua.GuiObject (Object)

Up one category:
Class reference

[▲] GuiObject (extends GuiBase) method TweenPosition method TweenSize method TweenSizeAndPosition method Clone method FindFirstChild method GetChildren method GetDebugId method GetFullName method IsA method IsAncestorOf method IsDescendantOf method Destroy method ClearAllChildren property Active property BackgroundColor3 property BackgroundTransparency property BorderColor3 property BorderSizePixel property Position property Size property SizeConstraint property Visible property ZIndex property Draggable property ClipDescendants property AbsolutePosition property AbsoluteSize property Name property Parent property Archivable property ClassName property RobloxLocked property DataCost event MouseEnter event MouseLeave event MouseMoved event DragBegin event DragStopped event AncestryChanged event Changed event ChildAdded event ChildRemoved event DescendantAdded event DescendantRemoving

A GuiObject is a Structural Class type of object that cannot be created. It is the base for most other 2D GUI objects, it's properties are inherited to it's children.

Hierarchy Parent: GuiBase Child: Frame Child: GuiButton Child: GuiLabel Child: TextBox

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

GetDebugId( int scopeLength )
Returns	string
Description:	Returns a coded string of the object's DebugId used internally by Roblox.
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

AbsolutePosition
Type	Vector2
Description	The distance, in pixels, from the top left corner of the game window.
Member of	GuiBase

AbsoluteSize
Type	Vector2
Description	Size of the render window in pixels.
Member of	GuiBase

Active
Type	bool
Description	true will react to mouse events, and pass them to any objects layered underneath, while false won't.
Member of	BillboardGui, GuiObject, HopperBin

BackgroundColor3
Property	Color3 background color
Description	Sets the color of the background on the item.
Member of	GuiObject

BackgroundTransparency
Property	Number Transparency
Description	Sets the transparency of the background of a GUI. (1 is completely transparent; 0 is completely opaque)
Member of	GuiObject

BorderColor3
Property	Color3 BorderColor
Description	Sets the color of the border around a GUI.
Member of	GuiObject

BorderSizePixel
Type	int
Description	This property can either be 0 or 1, the former having no border, the latter having a one pixel border.
Member of	GuiObject

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

When used in 3D objects, such as Parts and other items, this property is a Vector3.

Position
Property	Vector3 Position
Description	Stores the current location of the object in world coordinates.
Member of	BasePart, Explosion

Position
Property	UDim2 Position
Description	Sets the position of the GUI object in object coordinates.
Member of	GuiObject

Note, the lowercase property operates differently. Rather than setting the location of an object, the lowercase position property specifies a goal location for that object.

position
Property	Vector3 position
Description	Sets the goal position for the object.
Member of	BodyPosition

Up one category:
Properties

When used in 3D objects, this property is a Vector3 representing how big, on each side, an object is. Size Property Vector3 Size Description Sets the size of the object in object coordinates. Member of BasePart

When used in 2D GUI objects, this property is a UDim2 representing the size of an object. Size Property UDim2 Size Description Sets the size of the GUI object in object coordinates. Member of GuiObject

In the fire or smoke object, Size is an Int.

Size
Property	Int Size
Description	Sets the size of flames or smoke based on an integer.
Member of	Fire, Smoke

SizeConstraint
Property	SizeConstraint SizeConstraint
Description	Sets the direction that an object can be resized in.
Member of	GuiObject

Visible
Property	bool
Description	Determines whether the object and its descendants will be displayed.
Member of	GuiObject, LoadingGui, GuiBase3d

ZIndex
Property	Integer ZIndex
Description	Alters the order in which GUI items are placed.
Member of	GuiObject

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

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

Changed ( type Value )
Description	Fired after the Value property is changed. This is present but does not work in 2008M, it uses the other version of this event instead.
Member of:	BoolValue, BrickColorValue, CFrameValue, Color3Value, IntValue, NumberValue, ObjectValue, StringValue, Vector3Value, RayValue

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

There is a special event for 2D GUI objects.

MouseEnter ( int x, int y )
Description	Fired when the mouse enters a GuiObject, as long as the GuiObject is active (see active property for more detail). Arguments x, and y specify the absolute pixel position of the mouse.
Member of:	GuiObject

There is also a special event for 3D Handle objects.

MouseEnter ( )
Description	Fired when a mouse "enters" or "touches" a 3D Object.
Member of:	ArcHandles, Handles

MouseLeave ( )
Description	Fired when a mouse "leaves" or moves off of a GUI Object.
Member of:	GuiObject

MouseMoved ( Integer x, Integer y )
Description	Fired when the mouse moves or goes on top of a GUI Object.
Member of:	GuiObject