This site is inactive!

This site is no longer kept up to date. It has been superseded by the Roblox API Reference. Please update your bookmarks.

Members

YieldFunctions

Returns YieldFunction History
string BlockUser ( int blockerUserId, int blockeeUserId ) (+0.181, −0.284)
Instance GetCharacterAppearanceAsync ( int64 userId ) (+0.212)
Dictionary GetCharacterAppearanceInfoAsync ( int64 userId ) (+0.306)
Instance GetFriendsAsync ( int64 userId ) (+0.204)
string GetNameFromUserIdAsync ( int64 userId ) (+0.202)
int64 GetUserIdFromNameAsync ( string userName ) (+0.202)
Tuple GetUserThumbnailAsync ( int64 userId, ThumbnailType thumbnailType, ThumbnailSize thumbnailSize ) (+0.287)
string UnblockUser ( int exblockerUserId, int exblockeeUserId ) (+0.181, −0.284)
  • 1 yieldfunction inherited from Instance

Events

Event History
FriendRequestEvent ( Instance player, Instance player, FriendRequestEvent friendRequestEvent )
GameAnnounce ( string message )
PlayerAdded ( Instance player )
PlayerAddedEarly ( Instance player ) (−0.310)
PlayerChatted ( PlayerChatType chatType, Instance player, string message, Instance targetPlayer )
PlayerConnecting ( Instance player ) (+0.272)
PlayerDisconnecting ( Instance player ) (+0.272)
PlayerRejoining ( Instance player ) (+0.272)
PlayerRemoving ( Instance player )
PlayerRemovingLate ( Instance player ) (−0.310)

Property Descriptions

bool Players.BubbleChat

Tags: readonly

bool Players.CharacterAutoLoads

Version History:(+0.55)

bool Players.ClassicChat

Tags: readonly

Class:Instance Players.LocalPlayer

Tags: readonly

int Players.MaxPlayers

Tags: readonly

int Players.MaxPlayersInternal

Version History:(+0.209)

Tags: LocalUserSecurity

int Players.PreferredPlayers

Version History:(+0.209)

Tags: readonly

int Players.PreferredPlayersInternal

Version History:(+0.209)

Tags: LocalUserSecurity

int Players.NumPlayers

Deprecated: This member is deprecated.

Tags: readonly

Class:Instance Players.localPlayer

Version History:(+0.50)

Deprecated: This member is deprecated.

Tags: hidden, readonly

int Players.numPlayers

Version History:(+0.61)

Deprecated: This member is deprecated.

Tags: hidden, readonly

Function Descriptions

voidPlayers.AddLeaderboardKey ( string key )

Version History:(−0.258)

Tags: LocalUserSecurity

voidPlayers.Chat ( string message )

Tags: PluginSecurity

InstancePlayers.CreateLocalPlayer ( )

Tags: LocalUserSecurity

InstancePlayers.GetPlayerById ( int userId )

Version History:(+0.210, −0.310)

Tags: LocalUserSecurity

InstancePlayers.GetPlayerByUserId ( int64 userId )

Version History:(+0.202)

InstancePlayers.GetPlayerFromCharacter ( Instance character )

ObjectsPlayers.GetPlayers ( )

boolPlayers.GetUseCoreScriptHealthBar ( )

Version History:(+0.142, −0.310)

Tags: RobloxScriptSecurity

voidPlayers.ReportAbuse ( Instance player, string reason, string optionalMessage )

Tags: LocalUserSecurity

voidPlayers.SetAbuseReportUrl ( string url )

Version History:(−0.310)

Tags: RobloxSecurity

voidPlayers.SetBuildToolsUrl ( string url )

Version History:(−0.51)

Tags: RobloxSecurity

voidPlayers.SetBuildUserPermissionsUrl ( string url )

Version History:(−0.310)

Tags: RobloxSecurity

voidPlayers.SetChatFilterUrl ( string url )

Version History:(−0.310)

Tags: RobloxSecurity

voidPlayers.SetChatStyle ( ChatStyle style = Classic )

Tags: PluginSecurity

voidPlayers.SetLoadDataUrl ( string url )

Version History:(−0.310)

Tags: LocalUserSecurity

voidPlayers.SetSaveDataUrl ( string url )

Version History:(−0.310)

Tags: LocalUserSecurity

voidPlayers.SetSaveLeaderboardDataUrl ( string url )

Version History:(−0.258)

Tags: LocalUserSecurity

voidPlayers.SetSysStatsUrl ( string url )

Version History:(−0.310)

Tags: LocalUserSecurity

voidPlayers.SetSysStatsUrlId ( string urlId )

Version History:(−0.310)

Tags: LocalUserSecurity

voidPlayers.TeamChat ( string message )

Tags: PluginSecurity

voidPlayers.WhisperChat ( string message, Instance player )

Tags: LocalUserSecurity

InstancePlayers.GetPlayerByID ( int userID )

Version History:(−0.310)

Deprecated: This member is deprecated.

Tags: LocalUserSecurity

InstancePlayers.getPlayerFromCharacter ( Instance character )

Version History:(+0.49)

Deprecated: This member is deprecated.

ObjectsPlayers.getPlayers ( )

Version History:(+0.49)

Deprecated: This member is deprecated.

InstancePlayers.playerFromCharacter ( Instance character )

Deprecated: This member is deprecated.

ObjectsPlayers.players ( )

Deprecated: This member is deprecated.

YieldFunction Descriptions

stringPlayers.BlockUser ( int blockerUserId, int blockeeUserId )

Version History:(+0.181, −0.284)

Tags: RobloxScriptSecurity

InstancePlayers.GetCharacterAppearanceAsync ( int64 userId )

Version History:(+0.212)

DictionaryPlayers.GetCharacterAppearanceInfoAsync ( int64 userId )

Version History:(+0.306)

InstancePlayers.GetFriendsAsync ( int64 userId )

Version History:(+0.204)

stringPlayers.GetNameFromUserIdAsync ( int64 userId )

Version History:(+0.202)

int64Players.GetUserIdFromNameAsync ( string userName )

Version History:(+0.202)

TuplePlayers.GetUserThumbnailAsync ( int64 userId, ThumbnailType thumbnailType, ThumbnailSize thumbnailSize )

Version History:(+0.287)

stringPlayers.UnblockUser ( int exblockerUserId, int exblockeeUserId )

Version History:(+0.181, −0.284)

Tags: RobloxScriptSecurity

Event Descriptions

Players.FriendRequestEvent ( Instance player, Instance player, FriendRequestEvent friendRequestEvent )

Tags: RobloxScriptSecurity

Players.GameAnnounce ( string message )

Tags: RobloxScriptSecurity

Players.PlayerAdded ( Instance player )

Players.PlayerAddedEarly ( Instance player )

Version History:(−0.310)

Tags: LocalUserSecurity

Players.PlayerChatted ( PlayerChatType chatType, Instance player, string message, Instance targetPlayer )

Tags: LocalUserSecurity

Players.PlayerConnecting ( Instance player )

Version History:(+0.272)

Tags: LocalUserSecurity

Players.PlayerDisconnecting ( Instance player )

Version History:(+0.272)

Tags: LocalUserSecurity

Players.PlayerRejoining ( Instance player )

Version History:(+0.272)

Tags: LocalUserSecurity

Players.PlayerRemoving ( Instance player )

Players.PlayerRemovingLate ( Instance player )

Version History:(−0.310)

Tags: LocalUserSecurity

Inherits: