LoadCharacter (Method): Difference between revisions
From Legacy Roblox Wiki
Jump to navigationJump to search
>Anaminus unprotected; expanded description |
>JulienDethurens No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude>{{Method | <onlyinclude>{{Method | ||
|name = LoadCharacter | |name = LoadCharacter | ||
|arguments = [[bool]] <var>inGame | |arguments = [[bool]] <var>inGame</var> = true | ||
|description = Loads in a new character for this player. This will replace the player's current character, if they have one. | |description = Loads in a new character for this player. This will replace the player's current character, if they have one. | ||
|object = Player | |object = Player | ||
}}</onlyinclude> | }}</onlyinclude> | ||
| Line 22: | Line 22: | ||
This script turns off auto-loading and simulates character respawning. | This script turns off auto-loading and simulates character respawning. | ||
{{code|= | |||
local respawnTime = 5 | local respawnTime = 5 | ||
| Line 42: | Line 42: | ||
Player:LoadCharacter(true) -- load the character for the first time | Player:LoadCharacter(true) -- load the character for the first time | ||
end) | end) | ||
}} | |||
[[Category:Methods]] | [[Category:Methods]] | ||
Revision as of 21:32, 10 April 2012
 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 |
Remarks
LoadCharacter should be used in conjunction with Players.CharacterAutoLoads to control spawning of characters. This method only works from a server-side Script (not a LocalScript).
If inGame is true, then a default character will be loaded, then the Player's CharacterAppearance will be applied.
If inGame is false, then a character with the most recently loaded CharacterAppearance is used.
Example
This script turns off auto-loading and simulates character respawning.
local respawnTime = 5
local Players = Game:GetService("Players")
Players.CharacterAutoLoads = false
Players.PlayerAdded:connect(function(Player)
Player.CharacterAdded:connect(function(Character)
local Humanoid = Character:FindFirstChild("Humanoid")
if Humanoid then
Humanoid.Died:connect(function()
-- find the humanoid, and detect when it dies
wait(respawnTime)
Player:LoadCharacter()
end)
end
end)
Player:LoadCharacter(true) -- load the character for the first time
end)
