概要
屬性
方法
活動
PlayerAdded(player: Player):RBXScriptSignal |
PlayerMembershipChanged(player: Player):RBXScriptSignal |
PlayerRemoving(player: Player,reason: Enum.PlayerExitReason):RBXScriptSignal |
UserSubscriptionStatusChanged(user: Player,subscriptionId: string):RBXScriptSignal |
API 參考
屬性
CharacterAutoLoads
範例程式碼
玩家重生計時器
local Players = game:GetService("Players")
-- 設定 CharacterAutoLoads 為 false
Players.CharacterAutoLoads = false
-- 在玩家死亡時從工作空間移除玩家的角色
Players.PlayerAdded:Connect(function(player)
while true do
local char = player.CharacterAdded:Wait()
char.Humanoid.Died:Connect(function()
char:Destroy()
end)
end
end)
-- 每 10 秒重生所有死亡的玩家
while true do
local players = Players:GetChildren()
-- 檢查每個玩家是否死亡,透過檢查他們是否有角色,如果死亡則加載該玩家的角色
for _, player in pairs(players) do
if not workspace:FindFirstChild(player.Name) then
player:LoadCharacterAsync()
end
end
-- 等待 10 秒直到下一次重生檢查
task.wait(10)
endlocalPlayer
NumPlayers
numPlayers
方法
BanAsync
參數
返回
()
範例程式碼
禁止用戶
local Players = game:GetService("Players")
if shouldBeBanned(player) then
local banHistoryPages = Players:GetBanHistoryAsync(player.UserId)
local duration = 86400 -- 24 小時的秒數。建議:根據用戶的 BanHistory 使用您自己的邏輯
local config: BanConfigType = {
UserIds = { player.UserId },
Duration = duration,
DisplayReason = "您違反了社區準則 #5",
PrivateReason = "在這裡放入用戶不應該知道但對您的記錄有幫助的任何內容",
ExcludeAltAccounts = false,
ApplyToUniverse = true,
}
local success, err = pcall(function()
return Players:BanAsync(config)
end)
print(success, err)
endChat
CreateHumanoidModelFromDescription
CreateHumanoidModelFromDescriptionAsync
Players:CreateHumanoidModelFromDescriptionAsync(
description:HumanoidDescription, rigType:Enum.HumanoidRigType, assetTypeVerification:Enum.AssetTypeVerification
參數
| 預設值:"Default" |
返回
範例程式碼
從描述創建人形模型
game.Players:CreateHumanoidModelFromDescriptionAsync(Instance.new("HumanoidDescription"), Enum.HumanoidRigType.R15).Parent =
game.WorkspaceCreateHumanoidModelFromUserId
CreateHumanoidModelFromUserIdAsync
GetBanHistoryAsync
GetCharacterAppearanceAsync
GetCharacterAppearanceInfoAsync
參數
範例程式碼
範例返回角色外觀字典
local result = {
playerAvatarType = "R15",
defaultPantsApplied = false,
defaultShirtApplied = false,
scales = {
bodyType = 0,
head = 1,
height = 1.05,
proportion = 0,
depth = 0.92,
width = 0.85,
},
bodyColors = {
leftArmColorId = 1030,
torsoColorId = 1001,
rightArmColorId = 1030,
headColorId = 1030,
leftLegColorId = 1001,
rightLegColorId = 1001,
},
assets = {
{
id = 1031492,
assetType = {
name = "Hat",
id = 8,
},
name = "條紋帽",
},
{
id = 13062491,
assetType = {
name = "Face Accessory",
id = 42,
},
name = "法式視覺",
},
{
id = 16598440,
assetType = {
name = "Neck Accessory",
id = 43,
},
name = "紅色蝴蝶結",
},
{
id = 28999228,
assetType = {
name = "Face",
id = 18,
},
name = "喜悅驚訝",
},
{
id = 86896488,
assetType = {
name = "Shirt",
id = 11,
},
name = "昂貴的紅色晚禮服外套",
},
{
id = 86896502,
assetType = {
name = "Pants",
id = 12,
},
name = "昂貴的紅色晚禮服褲子",
},
{
id = 376530220,
assetType = {
name = "Left Arm",
id = 29,
},
name = "ROBLOX 男孩左臂",
},
{
id = 376531012,
assetType = {
name = "Right Arm",
id = 28,
},
name = "ROBLOX 男孩右臂",
},
{
id = 376531300,
assetType = {
name = "Left Leg",
id = 30,
},
name = "ROBLOX 男孩左腿",
},
{
id = 376531703,
assetType = {
name = "Right Leg",
id = 31,
},
name = "ROBLOX 男孩右腿",
},
{
id = 376532000,
assetType = {
name = "Torso",
id = 27,
},
name = "ROBLOX 男孩軀幹",
},
},
}
print(result)GetFriendsAsync
參數
範例程式碼
列印 Roblox 朋友
local Players = game:GetService("Players")
local USERNAME = "Cozecant"
local function iterPageItems(pages)
return coroutine.wrap(function()
local pagenum = 1
while true do
for _, item in ipairs(pages:GetCurrentPage()) do
coroutine.yield(item, pagenum)
end
if pages.IsFinished then
break
end
pages:AdvanceToNextPageAsync()
pagenum = pagenum + 1
end
end)
end
-- 首先,獲取玩家的使用者 ID
local userId = Players:GetUserIdFromNameAsync(USERNAME)
-- 然後,為他們的朋友獲取一個 FriendPages 對象
local friendPages = Players:GetFriendsAsync(userId)
-- 遍歷頁面中的項目。對於 FriendPages,這些
-- 是有關朋友的資訊表,包括使用者名稱。
-- 在一個表中收集每個使用者名稱
local usernames = {}
for item, _pageNo in iterPageItems(friendPages) do
table.insert(usernames, item.Username)
end
print("連線的 " .. USERNAME .. ": " .. table.concat(usernames, ", "))GetHumanoidDescriptionFromOutfitId
GetHumanoidDescriptionFromOutfitIdAsync
參數
範例程式碼
從服裝 ID 獲取 HumanoidDescription
local Players = game:GetService("Players")
local Workspace = game:GetService("Workspace")
local function getOutfitId(bundleId)
if bundleId <= 0 then
return
end
local info = game.AssetService:GetBundleDetailsAsync(bundleId)
if not info then
return
end
for _, item in pairs(info.Items) do
if item.Type == "UserOutfit" then
return item.Id
end
end
return nil
end
local function getHumanoidDescriptionBundle(bundleId)
local itemId = getOutfitId(bundleId)
if itemId and itemId > 0 then
return Players:GetHumanoidDescriptionFromOutfitIdAsync(itemId)
end
return nil
end
local humanoidDescription = getHumanoidDescriptionBundle(799)
local humanoidModel = Players:CreateHumanoidModelFromDescriptionAsync(humanoidDescription, Enum.HumanoidRigType.R15)
humanoidModel.Parent = WorkspaceGetHumanoidDescriptionFromUserId
GetHumanoidDescriptionFromUserIdAsync
參數
範例程式碼
從使用者ID獲取HumanoidDescription
game.Players:CreateHumanoidModelFromDescriptionAsync(
game.Players:GetHumanoidDescriptionFromUserIdAsync(1),
Enum.HumanoidRigType.R15
).Parent =
game.WorkspaceGetNameFromUserIdAsync
參數
返回
範例程式碼
從 UserId 獲取名稱
local Players = game:GetService("Players")
-- 範例資料:
-- UserId: 118271 名稱: "RobloxRulez"
-- UserId: 131963979 名稱: "docsRule"
local nameOne = Players:GetNameFromUserIdAsync(118271)
local nameTwo = Players:GetNameFromUserIdAsync(131963979)
print(nameOne, nameTwo)
-- 輸出: "RobloxRulez docsRule"從 UserId 獲取名稱(使用快取)
local Players = game:GetService("Players")
-- 創建一個名為 'cache' 的表格,
-- 用於存儲每個 'Name' 當它們被找到時。
-- 如果我們使用相同的 'UserId' 查找 'Name',
-- 'Name' 將來自快取(快速),而不是 GetNameFromUserIdAsync()
-- (會產生)。
local cache = {}
function getNameFromUserId(userId)
-- 首先,檢查快取是否包含 'userId'
local nameFromCache = cache[userId]
if nameFromCache then
-- 如果在快取中以 'userId' 為鍵存儲了一個值,
-- 則此 'nameFromCache' 是正確的名稱,我們可以返回它。
return nameFromCache
end
-- 如果到這裡,則 'userId' 之前未查找過,
-- 並且不在快取中。現在我們需要使用 GetNameFromUserIdAsync()
-- 來查找名稱
local name
local success, _ = pcall(function()
name = Players:GetNameFromUserIdAsync(userId)
end)
if success then
-- 如果 'success' 為真,則 GetNameFromUserIdAsync() 成功找到了
-- 名稱。使用 'userId' 作為鍵將此名稱存儲到快取中,
-- 這樣我們未來就不必再查找此名稱。然後返回名稱。
cache[userId] = name
return name
end
-- 如果到這裡,'success' 為假,這意味著 GetNameFromUserIdAsync()
-- 無法為提供的 'userId' 找到 'name'。提醒用戶
-- 發生了此情況,然後返回空或 nil。
warn("無法找到 UserId 的名稱:", userId)
return nil
end
-- 示例數據:
-- UserId: 118271 名稱: "RobloxRulez"
-- UserId: 131963979 名稱: "docsRule"
-- 當首次使用 UserId 時,將調用 GetNameFromUserIdAsync()
local nameOne = getNameFromUserId(118271)
local nameTwo = getNameFromUserId(131963979)
-- 因為 118271 之前被使用,所以從快取中獲取其名稱
local nameOneQuick = getNameFromUserId(118271)
print(nameOne, nameTwo, nameOneQuick)
-- 輸出: "RobloxRulez docsRule RobloxRulez"GetPlayerByUserId
GetPlayerFromCharacter
參數
返回
範例程式碼
玩家: 從角色獲取玩家
local Players = game:GetService("Players")
local Workspace = game:GetService("Workspace")
local PLAYER_NAME = "Nightriff"
local character = Workspace:FindFirstChild(PLAYER_NAME)
local player = Players:GetPlayerFromCharacter(character)
if player then
print(`玩家 {player.Name} ({player.UserId}) 在遊戲中`)
else
print(`玩家 {PLAYER_NAME} 不在遊戲中!`)
endGetPlayers
返回
{Player}
範例程式碼
給予每個人閃爍特效
local Players = game:GetService("Players")
local function onCharacterAdded(character)
-- 如果他們的頭上還沒有閃爍特效,就給他們閃爍特效
if not character:FindFirstChild("Sparkles") then
local sparkles = Instance.new("Sparkles")
sparkles.Parent = character:WaitForChild("Head")
end
end
local function onPlayerAdded(player)
-- 檢查他們是否已經生成了
if player.Character then
onCharacterAdded(player.Character)
end
-- 監聽玩家(重新)生成的事件
player.CharacterAdded:Connect(onCharacterAdded)
end
Players.PlayerAdded:Connect(onPlayerAdded)getPlayers
GetUserIdFromNameAsync
參數
返回
範例程式碼
從名稱獲取使用者ID
local Players = game:GetService("Players")
-- 範例資料:
-- 使用者ID: 118271 名稱: "RobloxRulez"
-- 使用者ID: 131963979 名稱: "docsRule"
local userIdOne = Players:GetUserIdFromNameAsync("RobloxRulez")
local userIdTwo = Players:GetUserIdFromNameAsync("docsRule")
print(userIdOne, userIdTwo)
-- 輸出: "118271 131963979"使用快取從名稱獲取用戶ID
local Players = game:GetService("Players")
-- 創建一個名為 'cache' 的表來儲存每個 'UserId'。
-- 如果我們使用相同的 'Name' 查找 'UserId','UserId' 會來
-- 自 cache(快速)而不是 GetUserIdFromNameAsync()(產生暫停)。
local cache = {}
function getUserIdFromName(name)
-- 首先,檢查 cache 是否包含 'name'
local userIdFromCache = cache[name]
if userIdFromCache then
-- 如果在 cache 的 'name' 鍵中有儲存的值,
-- 則這個 'userIdFromCache'
-- 是正確的 UserId,我們可以返回它。
return userIdFromCache
end
-- 如果到這裡,'name' 之前未被查找且不在
-- cache 中。現在我們需要使用 GetUserIdFromNameAsync()
-- 查找 userId
local userId
local success, _ = pcall(function()
userId = Players:GetUserIdFromNameAsync(name)
end)
if success then
-- 如果 'success' 為 true,GetUserIdFromNameAsync() 成功找到了
-- userId。使用 'name' 作為鍵儲存這個 userId 到 cache,以便我們
-- 將來不必再次查找這個 userId。然後返回 userId。
cache[name] = userId
return userId
end
-- 如果到這裡,'success' 為 false,
-- 意味著 GetUserIdFromNameAsync()
-- 無法為提供的 'name' 找到 'userId'。我們可以警告
-- 用戶發生了這種情況,然後返回 nothing,或 nil。
warn("無法找到名稱的 UserId:", name)
return nil
end
-- 示例數據:
-- UserId: 118271 名稱: "RobloxRulez"
-- UserId: 131963979 名稱: "docsRule"
-- 首次使用名稱時,將調用 GetUserIdFromNameAsync()
local userIdOne = getUserIdFromName("RobloxRulez")
local userIdTwo = getUserIdFromName("docsRule")
-- 因為 "RobloxRulez" 之前已被使用,從 cache 獲取其 UserId
local userIdOneQuick = getUserIdFromName("RobloxRulez")
print(userIdOne, userIdTwo, userIdOneQuick)
-- 輸出: "118271 131963979 118271"GetUserThumbnailAsync
Players:GetUserThumbnailAsync(
參數
返回
範例程式碼
顯示玩家縮圖
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local PLACEHOLDER_IMAGE = "rbxassetid://0" -- 替換為佔位符圖像
-- 獲取縮圖
local userId = player.UserId
local thumbType = Enum.ThumbnailType.HeadShot
local thumbSize = Enum.ThumbnailSize.Size420x420
local content, isReady = Players:GetUserThumbnailAsync(userId, thumbType, thumbSize)
-- 將 ImageLabel 的內容設為用戶縮圖
local imageLabel = script.Parent
imageLabel.Image = (isReady and content) or PLACEHOLDER_IMAGE
imageLabel.Size = UDim2.new(0, 420, 0, 420)playerFromCharacter
players
SetChatStyle
參數
| 預設值:"Classic" |
返回
()
範例程式碼
設置玩家的聊天風格
-- 命令欄
game.Players:SetChatStyle(Enum.ChatStyle.Classic) -- 將聊天風格設置為經典
-- LocalScript
local Players = game:GetService("Players")
Players:SetChatStyle(Enum.ChatStyle.Classic) -- 發生錯誤TeamChat
UnbanAsync
參數
返回
()
範例程式碼
解除用戶禁用
local Players = game:GetService("Players")
if shouldBeUnbanned(player)
then
local config: UnbanConfigType = {
UserIds = { player.UserId, 789 },
ApplyToUniverse = false,
}
local success, err = pcall(function()
return Players:UnbanAsync(config)
end)
print(success, err)
end活動
PlayerAdded
參數
範例程式碼
玩家.PlayerAdded
local Players = game:GetService("Players")
local function onPlayerAdded(player)
print("一個玩家已進入: " .. player.Name)
end
Players.PlayerAdded:Connect(onPlayerAdded)PlayerMembershipChanged
參數
範例程式碼
處理高級會員變更
local Players = game:GetService("Players")
local function grantPremiumBenefits(player)
-- 授予玩家訪問僅限高級的區域、物品或任何你可以想像的東西!
print("給予", player, "高級福利!")
end
local function playerAdded(player)
if player.MembershipType == Enum.MembershipType.Premium then
grantPremiumBenefits(player)
end
end
local function playerMembershipChanged(player)
print("收到事件 PlayerMembershipChanged。新會員資格 = " .. tostring(player.MembershipType))
if player.MembershipType == Enum.MembershipType.Premium then
grantPremiumBenefits(player)
end
end
Players.PlayerAdded:Connect(playerAdded)
Players.PlayerMembershipChanged:Connect(playerMembershipChanged)PlayerRemoving
參數
範例程式碼
玩家.PlayerRemoving
local Players = game:GetService("Players")
local function onPlayerRemoving(player)
print("一個玩家已離開: " .. player.Name)
end
Players.PlayerRemoving:Connect(onPlayerRemoving)UserSubscriptionStatusChanged