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

From Legacy Roblox Wiki
Jump to navigationJump to search
>Outofspace
m Cat. added
We're getting template size issues, so here I'm breaking it up to just use the template's source code directly
 
(29 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{CatUp|Class reference}}
<div class="tabber visualClear" style="border:0; margin:0; zoom:1;">
<div class="tabbertab" title="Info">{{TitledBox|heading=Derived Classes|{{if|{{derived classes|Player}}|{{derived classes|Player}}|None}}|blue|float:right; margin-left: 4px; width:25%;}}{{ObjectPage/style|Player|float:left; width:25%; margin-left: 0}}{{EmphasisBox|The Player object contains all of a user's information while in game.


The Player object contains all of a user's information while ingame.
Click on something to learn more about it!
<imagemap>
Image:PlayerPic.png|


{{Service}}
rect 18 334 118 353 [[MembershipType_(Property)|MempershipType]]
rect 18 353 118 374 [[Name_(Property)|Name]]
rect 18 372 118 393 [[Parent_(Property)|Parent]]
rect 19 392 118 410 [[UserId_(Property)|UserID]]
rect 19 429 118 447 [[Archivable_(Property)|Archivable]]
rect 21 469 116 486 [[Neutral_(Property)|Neutral]]
rect 20 487 116 504 [[TeamColor_(Property)|TeamColor]]
rect 17 316 119 334 [[DataReady_(Property)|DataReady]]
rect 19 297 118 315 [[DataComplexity_(Property)|DataComplexity]]
rect 19 277 118 296 [[ClassName_(Property)|ClassName]]
rect 18 258 119 279 [[CharacterAppearance_(Property)|CharacterAppearance]]
rect 18 220 120 240 [[AccountAge_(Property)|AccountAge]]
rect 20 239 118 259 [[Character_(Property)|Character]]
rect 61 60 144 79 [[RBX.lua.Backpack_(Object)|Backpack]]
rect 61 79 144 96 [[RBX.lua.StarterGear_(Object)|StarterGear]]
rect 61 97 144 114 [[RBX.lua.PlayerGui_(Object)|PlayerGui]]
rect 22 23 91 42 [[RBX.lua.Players_(Object)|Players]]


==Functions==
desc none
In addition to the global functions, Player also has these:<br>
</imagemap>|green}}
''<font color="red"># indicates a locked function. These should NOT be tampered with.</font>''
</div>
 
<div class="tabbertab" title="Methods">
* <font color="red">#</font> LoadCharacter(bool inGame = true)
{{Members|Player|methods}}
* <font color="red">#</font> RemoveCharacter()
</div>
* <font color="red">#</font> SetSuperSafeChat(bool value)
<div class="tabbertab" title="Properties">
* <font color="red">#</font> SetUnder13(bool value)
{{Members|Player|properties}}
 
</div>
 
<div class="tabbertab" title="Callbacks">
==Properties==
{{Members|Player|callbacks}}
In addition to the global properties, Player also has these:
</div>
 
<div class="tabbertab" title="Events">
* [[Character]]
{{Members|Player|events}}
* [[CharacterAppearance]]
</div>
* [[Neutral]]
</div>
* [[TeamColor]]
{{if|{{{nocat<includeonly>|</includeonly>}}}||[[Category:ROBLOX Lua {{{type|Object}}}s|Player]]}}__NOTOC__<noinclude>
* [[userId]]
[[Category:Templates]]</noinclude>
 
==Events==
In addition to the global events, Player also has these:
 
* [[Chatted]]
* [[Idled]]
 
 
[[Category:ROBLOX Lua Objects]]

Latest revision as of 18:00, 10 September 2023

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
GetFriendStatus( Instance player )
Returns FriendStatus
Description: Returns the FriendStatus that player is to the player.
Member of: Player
GetWebPersonalServerRank( )
Returns Undocumented
Description: Undocumented
Member of: Undocumented
HasBuildPermission( BuildPermission role )
Returns Boolean build permission
Description: Returns true if player has permission for the role.
Member of: Player
IsFriendsWith( integer userId )
Returns boolean friendsWith
Description: Checks if the Player is friends with the user whose userId is inputted as an argument.
Member of: Player
IsBestFriendsWith( int userId )
Returns bool
Description: Checks if the Player is best friends with the user whose userId is inputted as an argument.
Member of: Player
IsInGroup( integer groupId )
Returns boolean memberOfGroup
Description: Checks if the Player is in the group whose groupId is inputted as an argument.
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
LoadData( )
Returns nil
Description: Loads data from the Roblox website to be changed via the data persistence methods. Also makes the Player's DataReady boolean value true if said data is accessible.
Member of: Player
LoadBoolean( string key )
Returns bool
Description: Returns a boolean value that was previously saved to the player via SaveBoolean with the same key. Returns false if the key doesn't exist, not nil.
Member of: Player
LoadInstance( string key )
Returns RBX.lua.Instance (Object)
Description: Loads an instance value that was previously saved to the player via SaveInstance.
Member of: Player
LoadNumber( string key )
Returns number
Description: Returns a number value that was previously saved to the player via SaveNumber with the same key. If the key doesn't exist, it returns 0, not nil.
Member of: Player
LoadString( string key )
Returns string
Description: Returns a string value that was previously saved to the player via SaveString with the same key. Returns an empty string ("") if key doesn't exist, not nil.
Member of: Player
RemoveCharacter( )
Returns nil
Description: Sets the parent of the Player's character to nil.
Member of: Player
RequestFriendship( Instance player )
Returns nil
Description: Requests to be friends with player.
Member of: Player
RevokeFriendship( Instance player )
Returns nil
Description: Revokes a requested friendship from RequestFriendship if the player hasn't already accepted or declined.
Member of: Player
RevokeFriendship( Instance player )
Returns nil
Description: Revokes a requested friendship from RequestFriendship if the player hasn't already accepted or declined.
Member of: Player
SaveData( )
Returns nil
Description: Saves stored Data Persistence data.
Member of: Player
SaveLeaderboardData( )
Returns Undocumented
Description: Undocumented
Member of: Undocumented
SaveBoolean( string key, bool value )
Returns nil
Description: Saves a boolean value that can be reloaded from any server via LoadBoolean.
Member of: Player
SaveInstance( string key, RBX.lua.Instance (Object) value )
Returns nil
Description: Saves a Roblox instance, such as a part that can be reloaded on another server via LoadInstance. The DataComplexity used is the Object's DataCost property. Saving nil removes the entry and frees up DataComplexity units..
Member of: Player
SaveNumber( string key, float value )
Returns nil
Description: Saves a number value that can be reloaded from any server via LoadNumber. The DataCost taken up by a saved number can be removed by saving 0 as the value.
Member of: Player
SaveString( string key, string value )
Returns nil
Description: Saves a string that can be reloaded from any server via LoadString. The DataCost used by a saved string can be removed by saving an empty string ("") as the value.
Member of: Player
SetAccountAge( Integer accountAge )
Returns nil
Description: Sets the AccountAge property to the argument passed.
Member of: Player
SetMembershipType( MembershipType membershipType )
Returns nil
Description: Sets the MembershipType to the argument.
Member of: Player
SetSuperSafeChat( boolean enable )
Returns nil
Description: Set to true to disable regular chat, set to false to enable.
Member of: Player
SetSuperSafeChat( boolean enable )
Returns nil
Description: Set to true to disable regular chat, set to false to enable.
Member of: Player
SetWebPersonalServerRank( )
Returns Undocumented
Description: Undocumented
Member of: Undocumented
WaitForDataReady( )
Returns nil
Description: This method pauses your script until the saved data is ready to be accessed.
Member of: Player
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
Destroy( )
Returns nil
Description: Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of: Instance
ClearAllChildren( )
Returns nil
Description: Removes all descendants of the Instance, but leaves the Instance itself.
Member of: Instance
AccountAge
Type int
Description Holds the number of days since the Player's account was made.
Member of Player
AppearanceDidLoad
Property Undocumented
Description Undocumented
Member of Undocumented
ChatMode
Property Undocumented
Description Undocumented
Member of Undocumented
Character
Type Model
Description A model containing the parts, joints, and scripts for the corresponding Character to the Player in Workspace.
Member of Player
CharacterAppearance
Property Content characterAppearance
Description URI of the asset containing character's appearance, clothing, and gear.
Member of Player
DataReady
Property Bool DataReady
Description Becomes true when player has connected to ROBLOX Data-Sharing.
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
MembershipType
Property MembershipType MembershipType
Description Holds an enum of the account's membership type.
Member of Player
MembershipTypeReplicate
Property MembershipType membershipType
Description A replicate of MembershipType.
Member of 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
CameraMode
Type CameraMode
Description Changes mode of camera - either first/third person or first person only
Member of Player
HasBuildTools
Property Undocumented
Description Undocumented
Member of Undocumented
Protected:This item is protected. Attempting to use it in a Script or LocalScript will cause an error.
Guest
Type bool
Description Whether the player is a guest.
Member of Player
PersonalServerRank
Property Undocumented
Description Undocumented
Member of Undocumented
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
RobloxLocked
Type bool
Description If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of Instance
DataCost
Type int
Description How much saving this instance with SaveInstance will add to DataComplexity
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
Chatted ( String message, Instance recipient )
Description Fired when the owning player types a chat in chat bar or selects a phrase in safe chat menu.
Member of: Player
FriendStatusChanged ( Instance player, FriendStatus newFriendStatus )
Description Fired when the friendship between the connected Player and player is changed.
Member of: Player
HoverOnPlayerChanged ( )
Description Undocumented
Member of: Undocumented
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 ( )
Description Undocumented
Member of: Undocumented
LockResult ( )
Description Undocumented
Member of: Undocumented
MouseDownOnPlayer ( )
Description Undocumented
Member of: Undocumented
RemoteInsert ( )
Description Undocumented
Member of: Undocumented
RequestLock ( )
Description Undocumented
Member of: Undocumented
RequestUnlock ( )
Description Undocumented
Member of: Undocumented
ScriptSecurityError ( )
Description Undocumented
Member of: Undocumented
StatsAvailable ( )
Description Undocumented
Member of: Undocumented
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