RBX.lua.Player (Object)

Up one category:
Class reference

Player (extends Instance) method DistanceFromCharacter method GetFriendStatus method GetWebPersonalServerRank method HasBuildPermission method IsFriendsWith method IsBestFriendsWith method IsInGroup method LoadCharacter method LoadData method LoadBoolean method LoadInstance method LoadNumber method LoadString method RemoveCharacter method RequestFriendship method RevokeFriendship method RevokeFriendship method SaveData method SaveLeaderboardData method SaveBoolean method SaveInstance method SaveNumber method SaveString method SetAccountAge method SetMembershipType method SetSuperSafeChat method SetUnder13 method SetWebPersonalServerRank method WaitForDataReady method Clone method FindFirstChild method GetChildren method GetDebugId method GetFullName method IsA method IsAncestorOf method IsDescendantOf method Destroy method ClearAllChildren property AccountAge property AppearanceDidLoad property ChatMode property Character property CharacterAppearance property DataReady property Neutral property MembershipType property MembershipTypeReplicate property TeamColor property userId property CameraMode property HasBuildTools property Guest property PersonalServerRank property Name property Parent property Archivable property ClassName property RobloxLocked property DataCost event CharacterAdded event CharacterRemoving event Chatted event FriendStatusChanged event HoverOnPlayerChanged event Idled event Kill event LockResult event MouseDownOnPlayer event RemoteInsert event RequestLock event RequestUnlock event ScriptSecurityError event StatsAvailable event AncestryChanged event Changed event ChildAdded event ChildRemoved event DescendantAdded event DescendantRemoving

The Player object contains all of a user's information while ingame.

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

DistanceFromCharacter( Vector3 point )
Returns	float
Description:	Returns the distance between the character's head and a given Vector3 point. Returns 0 if the player has no character.
Member of:	Player, PseudoPlayer

HasBuildPermission( BuildPermission role )
Returns	Boolean build permission
Description:	Returns true if player has permission for the role.
Member of:	Player

LoadCharacter( bool inGame = true )
Returns	nil
Description:	Loads in a new character for this player. This will replace the player's current character, if they have one.
Member of:	Player

RemoveCharacter (Function)

SetSuperSafeChat( boolean enable )
Returns	nil
Description:	Set to true to disable regular chat, set to false to enable.
Member of:	Player

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

Character
Type	Model
Description	A model containing the parts, joints, and scripts for the corresponding Character to the Player in Workspace.
Member of	Player

Neutral
Property	Bool Neutral
Description	When enabled, it means the player or spawn is not on a specific team.
Member of	SpawnLocation, Player

TeamColor
Property	BrickColor teamColor
Description	Sets the color of the team.
Member of	SpawnLocation, Team, Player

userId
Property	Number userId
Description	Holds the value for the user identification.
Member of	Player

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

CharacterAdded ( Instance character )
Description	Fired when a character spawns or respawns.
Member of:	Player

CharacterRemoving ( Model character )
Description	Fired when a character is about to be removed.
Member of:	Player

Idled ( Number time )
Description	Fired periodically after the user has been away for a while. Currently this event is only fired for the local Player. time is the time in seconds that the user has been idle.
Member of:	Player

Kill (Event) LockResult (Event) RemoveInsert (Event) RequestLock (Event) RequestUnlock (Event) ScriptSecurityError (Event) StatsAvailable (Event)