Skip to content

Commit 277eccd

Browse files
update Open Source Docs from Roblox internal teams
1 parent 48cc799 commit 277eccd

File tree

5 files changed

+82
-19
lines changed

5 files changed

+82
-19
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5004,6 +5004,11 @@ navigation:
50045004
type: engineapi
50055005
source: /reference/engine/enums/PlayerDataLoadFailureBehavior.yaml
50065006
ignoreTranslation: true
5007+
- title: PlayerExitReason
5008+
path: /reference/engine/enums/PlayerExitReason
5009+
type: engineapi
5010+
source: /reference/engine/enums/PlayerExitReason.yaml
5011+
ignoreTranslation: true
50075012
- title: PoseEasingDirection
50085013
path: /reference/engine/enums/PoseEasingDirection
50095014
type: engineapi

content/en-us/reference/engine/classes/Humanoid.yaml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,12 +1384,17 @@ methods:
13841384
type: HumanoidDescription
13851385
default:
13861386
summary: |
1387-
The `Class.HumanoidDescription` Instance which you want to set the
1387+
The `Class.HumanoidDescription` instance which you want to set the
13881388
character to match.
13891389
- name: assetTypeVerification
13901390
type: AssetTypeVerification
13911391
default: Default
1392-
summary: ''
1392+
summary: |
1393+
⚠️ The default value for this parameter will change from
1394+
`Enum.AssetTypeVerification.ClientOnly|ClientOnly` to
1395+
`Enum.AssetTypeVerification.Always|Always` after 10/20/2025. See
1396+
[here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903)
1397+
for details.
13931398
returns:
13941399
- type: ()
13951400
summary: ''
@@ -1430,7 +1435,12 @@ methods:
14301435
- name: assetTypeVerification
14311436
type: AssetTypeVerification
14321437
default: Default
1433-
summary: ''
1438+
summary: |
1439+
⚠️ The default value for this parameter will change from
1440+
`Enum.AssetTypeVerification.ClientOnly|ClientOnly` to
1441+
`Enum.AssetTypeVerification.Always|Always` after 10/20/2025. See
1442+
[here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903)
1443+
for details.
14341444
returns:
14351445
- type: ()
14361446
summary: ''

content/en-us/reference/engine/classes/Players.yaml

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -493,11 +493,12 @@ methods:
493493
- Players
494494
- name: Players:CreateHumanoidModelFromDescription
495495
summary: |
496-
Returns a character Model equipped with everything specified in the passed
497-
in HumanoidDescription, and is R6 or R15 as specified by the rigType.
496+
Returns a character `Class.Model` equipped with everything specified in
497+
the passed in `Class.HumanoidDescription`.
498498
description: |
499-
Returns a character Model equipped with everything specified in the passed
500-
in HumanoidDescription, and is R6 or R15 as specified by the rigType.
499+
Returns a character `Class.Model` equipped with everything specified in
500+
the passed in `Class.HumanoidDescription`, and is R6 or R15 as specified
501+
by `rigType`.
501502
code_samples:
502503
- create-humanoid-model-from-description
503504
parameters:
@@ -516,12 +517,15 @@ methods:
516517
default: Default
517518
summary: |
518519
Asset type verification determines if this function will load models
519-
or not (You should set this to Always unless you want to load
520-
non-catalog assets).
520+
or not. ⚠️ The default value for this parameter will change from
521+
`Enum.AssetTypeVerification.ClientOnly|ClientOnly` to
522+
`Enum.AssetTypeVerification.Always|Always` after 10/20/2025. See
523+
[here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903)
524+
for details.
521525
returns:
522526
- type: Model
523527
summary: |
524-
A Humanoid character Model.
528+
A `Class.Humanoid` character `Class.Model`.
525529
tags:
526530
- Yields
527531
deprecation_message: ''
@@ -1314,8 +1318,8 @@ events:
13141318
print(player.Name .. " joined the game!")
13151319
end)
13161320
1317-
Players.PlayerRemoving:Connect(function(player)
1318-
print(player.Name .. " left the game!")
1321+
Players.PlayerRemoving:Connect(function(player, reason)
1322+
print(player.Name .. " left the game! Reason: " .. tostring(exitReason))
13191323
end)
13201324
```
13211325
@@ -1401,8 +1405,8 @@ events:
14011405
print(player.Name .. " joined the game!")
14021406
end)
14031407
1404-
Players.PlayerRemoving:Connect(function(player)
1405-
print(player.Name .. " left the game!")
1408+
Players.PlayerRemoving:Connect(function(player, exitReason)
1409+
print(player.Name .. " left the game! - Reason: " .. tostring(reason))
14061410
end)
14071411
```
14081412
@@ -1418,6 +1422,11 @@ events:
14181422
default:
14191423
summary: |
14201424
An instance of the player that is leaving the game.
1425+
- name: reason
1426+
type: PlayerExitReason
1427+
default:
1428+
summary: |
1429+
Enum.PlayerExitReason in attempt to inform why.
14211430
tags: []
14221431
deprecation_message: ''
14231432
security: None

content/en-us/reference/engine/enums/AssetTypeVerification.yaml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ summary: |
88
Determines the asset type verification mode.
99
description: |
1010
Determines the asset type verification mode used when calling
11-
`Class.Humanoid:ApplyDescription()`. Asset type verification determines if
12-
ApplyDescription will load models or not. Loading models can be insecure if
13-
it's possible for malicious users to trick your game into loading unexpected
14-
models that you own which may include malicious scripts. You should set this
15-
to Always unless you want to load non-catalog assets.
11+
`Class.Humanoid:ApplyDescription()` or
12+
`Class.Players:CreateHumanoidModelFromDescription()`. This verification mode
13+
determines if the method will load models or not. Loading models can be
14+
insecure if it's possible for malicious users to trick your game into loading
15+
unexpected models that you own which may include malicious scripts. You should
16+
set this to `Always` unless you want to load non-catalog assets.
17+
18+
##### Warning
19+
20+
The default value for this parameter will change from `ClientOnly` to `Always`
21+
after 10/20/2025. See
22+
[here](https://devforum.roblox.com/t/potential-action-required-update-for-humanoiddescription-apis/3982903)
23+
for details.
1624
code_samples: []
1725
tags: []
1826
deprecation_message: ''
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This file is automatically generated. Please don't edit it manually.
2+
# To submit a bug report on the content, see
3+
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
4+
5+
name: PlayerExitReason
6+
type: enum
7+
summary: An enum that specifies the reason for **Players.PlayerRemoving** signal.
8+
description: |-
9+
Second argument in **Players.PlayerRemoving**. Helps identify on whether
10+
a kick was caused by the Roblox platform, of the Creator.
11+
code_samples: []
12+
tags: []
13+
deprecation_message: ''
14+
items:
15+
- name: Unknown
16+
summary: Catch-all for all other disconnect reasons.
17+
value: 0
18+
tags: []
19+
deprecation_message: ''
20+
- name: PlatformKick
21+
summary: |-
22+
User was kicked by Roblox systems, such as being blocked while in a
23+
Private Server.
24+
value: 1
25+
tags: []
26+
deprecation_message: ''
27+
- name: CreatorKick
28+
summary: Creator called **Player:Kick()**
29+
value: 2
30+
tags: []
31+
deprecation_message: ''

0 commit comments

Comments
 (0)