RBX.lua.Message (Object): Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>Wyoming
Updated for new layout, and a clearer description with images.
>Camoy
Deprecation label.
Line 7: Line 7:
|style="vertical-align:top"|{{:Object:Message}}
|style="vertical-align:top"|{{:Object:Message}}
|style="vertical-align:top"|{{LeftNoticeStart}}
|style="vertical-align:top"|{{LeftNoticeStart}}
{{Deprecated|Use [[TextLabel]] instead.}}


A '''Message''' is a ROBLOX instance which displays text on the screen, depending on where it is located in the game. If a Message is located as a descendant of the workspace, then it will fill the entire screen with a semi-transparent grey background, and display its [[Text (Property)|Text]] in the middle of the screen. If it is added '''directly''' inside a [[RBX.lua.Player (Object)|Player]] then it will show in the upper left of the screen in a smaller box, and will only be visible to the player it is within. The differences can be seen in the two images below.
A '''Message''' is a ROBLOX instance which displays text on the screen, depending on where it is located in the game. If a Message is located as a descendant of the workspace, then it will fill the entire screen with a semi-transparent grey background, and display its [[Text (Property)|Text]] in the middle of the screen. If it is added '''directly''' inside a [[RBX.lua.Player (Object)|Player]] then it will show in the upper left of the screen in a smaller box, and will only be visible to the player it is within. The differences can be seen in the two images below.

Revision as of 18:06, 27 August 2010

Message
Message (extends Instance)
method Clone
method FindFirstChild
method GetChildren
method GetDebugId
method GetFullName
method IsA
method IsAncestorOf
method IsDescendantOf
method Destroy
method ClearAllChildren
property Text
property Name
property Parent
property Archivable
property ClassName
property RobloxLocked
property DataCost
event AncestryChanged
event Changed
event ChildAdded
event ChildRemoved
event DescendantAdded
event DescendantRemoving
Deprecated:This item is deprecated. Do not use it for new work. Use TextLabel instead.

A Message is a ROBLOX instance which displays text on the screen, depending on where it is located in the game. If a Message is located as a descendant of the workspace, then it will fill the entire screen with a semi-transparent grey background, and display its Text in the middle of the screen. If it is added directly inside a Player then it will show in the upper left of the screen in a smaller box, and will only be visible to the player it is within. The differences can be seen in the two images below.

See Also

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
Text
Property String message text
Description Sets the text that the message displays.
Member of Hint, Message, TextBox, TextButton, TextLabel
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