Skip to content

Commit 866d8df

Browse files
authored
Small Writing Changes Humanoid.yaml
I made some writing changes to the Humanoid page. I know that the ChangeState() method has a long description, but I believe it is easier for beginners to understand.
1 parent 058da7d commit 866d8df

File tree

1 file changed

+61
-58
lines changed

1 file changed

+61
-58
lines changed

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

Lines changed: 61 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1419,7 +1419,7 @@ methods:
14191419
summary: |
14201420
Sets the `Class.Humanoid` to enter the given `Enum.HumanoidStateType`.
14211421
description: |
1422-
This function causes the `Class.Humanoid` to enter the given
1422+
This method causes the `Class.Humanoid` to enter the given
14231423
`Enum.HumanoidStateType`, describing the activity the `Class.Humanoid` is
14241424
currently doing.
14251425
@@ -1438,11 +1438,14 @@ methods:
14381438
`Enum.HumanoidStateType.PlatformStanding` will cause the humanoid state
14391439
to be automatically set to `Enum.HumanoidStateType.Running`.
14401440
1441-
Note that in order to set the `Class.Humanoid` state using this function,
1442-
you must do it in a `Class.LocalScript` owned by the NetworkOwner of the
1443-
`Class.Player.Character`. You can use this function in a `Class.Script`, but the NetworkOwner
1444-
of the `Class.Player.Character` must be the Server.
1445-
1441+
Note that in order to set the `Class.Humanoid` state using this method,
1442+
you must do so from a `Class.LocalScript`, and the Client must have the
1443+
[Network Ownership](../../../physics/network-ownership.md) of the
1444+
`Class.Player.Character`.
1445+
Alternatively, you can call this method from a `Class.Script`, but the
1446+
Server must have the [Network Ownership](../../../physics/network-ownership.md) of
1447+
the `Class.Player.Character`.
1448+
14461449
See also `Class.Humanoid:SetStateEnabled()` to enable or disable a
14471450
particular state, and `Class.Humanoid:GetState()` to get the current
14481451
humanoid state.
@@ -1467,7 +1470,7 @@ methods:
14671470
summary: |
14681471
Makes the `Class.Humanoid` equip the given `Class.Tool`.
14691472
description: |
1470-
This function makes the `Class.Humanoid` equip the given `Class.Tool`.
1473+
This method makes the `Class.Humanoid` equip the given `Class.Tool`.
14711474
14721475
The below example would cause a `Class.Player` to equip a tool in
14731476
`Class.Workspace` named _'Tool'_.
@@ -1488,13 +1491,13 @@ methods:
14881491
end
14891492
```
14901493
1491-
When this function is called, the `Class.Humanoid` will first
1494+
When this method is called, the `Class.Humanoid` will first
14921495
automatically unequip all `Class.Tool|Tools` that it currently has
14931496
equipped.
14941497
14951498
Although they will be equipped, `Class.Tool|Tools` for which
14961499
`Class.Tool.RequiresHandle` is _true_ will not function if they have no
1497-
handle, regardless if this function is used to equip them or not
1500+
handle, regardless if this method is used to equip them or not.
14981501
14991502
See also:
15001503
@@ -1520,7 +1523,7 @@ methods:
15201523
Returns an array of `Class.Accessory` objects that the humanoid's parent
15211524
is currently wearing.
15221525
description: |
1523-
This function returns an array of `Class.Accessory` objects that the
1526+
This method returns an array of `Class.Accessory` objects that the
15241527
humanoid's parent is currently wearing. All such `Class.Accessory` objects
15251528
will be included, regardless of whether they're attached or not.
15261529
@@ -1548,10 +1551,10 @@ methods:
15481551
Returns a copy of the humanoid's cached `Class.HumanoidDescription` which
15491552
describes its current look.
15501553
description: |
1551-
This function returns a copy of the humanoid's cached
1554+
This method returns a copy of the humanoid's cached
15521555
`Class.HumanoidDescription` which describes its current look. This can be
15531556
used to quickly determine a character's look and to assign their look to
1554-
other characters using the `Class.Humanoid:ApplyDescription()` function.
1557+
other characters using the `Class.Humanoid:ApplyDescription()` method.
15551558
15561559
#### See Also
15571560
@@ -1576,13 +1579,13 @@ methods:
15761579
writeCapabilities: []
15771580
- name: Humanoid:GetBodyPartR15
15781581
summary: |
1579-
Pass a body part to this function (the body part should be a sibling of
1582+
Pass a body part to this method (the body part should be a sibling of
15801583
Humanoid, and a child of a Model) to get the `Enum.BodyPartR15` of the
15811584
`Class.Part`.
15821585
description: |
1583-
This function returns what `Enum.BodyPartR15` a `Class.Part` is, or
1586+
This method returns what `Enum.BodyPartR15` a `Class.Part` is, or
15841587
`Enum.BodyPartR15.Unknown` if the part is not an R15 body part. This
1585-
function allows developers to retrieve player body parts independent of
1588+
method allows developers to retrieve player body parts independent of
15861589
what the actual body part names are, instead returning an enum.
15871590
15881591
It can be used in conjunction with `Class.Humanoid:ReplaceBodyPartR15()`.
@@ -1592,7 +1595,7 @@ methods:
15921595
developers can either perform some gameplay action or replace that part
15931596
with some other part - perhaps showing damage.
15941597
1595-
This function can be useful for games where hit location is important. For
1598+
This method can be useful for games where hit location is important. For
15961599
example, it can be used to determine if a player is hit in the leg and
15971600
then slow them down based on the injury.
15981601
code_samples:
@@ -1618,7 +1621,7 @@ methods:
16181621
Returns the `Enum.Limb` enum that is associated with the given
16191622
`Class.Part`.
16201623
description: |
1621-
This function returns the `Enum.Limb` enum that is associated with the
1624+
This method returns the `Enum.Limb` enum that is associated with the
16221625
given `Class.Part`. It works for both R15 and R6 rigs, for example:
16231626
16241627
```lua
@@ -1671,12 +1674,12 @@ methods:
16711674
Returns an array of all `Class.AnimationTrack|AnimationTracks` that are
16721675
currently being played on the `Class.Humanoid`.
16731676
description: |
1674-
This function returns an array of all
1677+
This method returns an array of all
16751678
`Class.AnimationTrack|AnimationTracks` that are currently being played on
1676-
the `Class.Humanoid`.c A typical use for this function is stopping
1679+
the `Class.Humanoid`. A typical use for this method is stopping
16771680
currently playing tracks using `Class.AnimationTrack:Stop()`.
16781681
1679-
Beware that this function will not return
1682+
Beware that this method will not return
16801683
`Class.AnimationTrack|AnimationTracks` that have loaded but are **not
16811684
playing**. If you want to track these you will need to index them
16821685
manually.
@@ -1697,7 +1700,7 @@ methods:
16971700
summary: |
16981701
Returns the humanoid's current `Enum.HumanoidStateType`.
16991702
description: |
1700-
This function returns the humanoid's current `Enum.HumanoidStateType`,
1703+
This method returns the humanoid's current `Enum.HumanoidStateType`,
17011704
describing the activity the `Class.Humanoid` is currently doing, such as
17021705
jumping or swimming.
17031706
@@ -1722,7 +1725,7 @@ methods:
17221725
Returns whether a `Enum.HumanoidStateType` is enabled for the
17231726
`Class.Humanoid`.
17241727
description: |
1725-
The GetStateEnabled function returns whether a `Enum.HumanoidStateType` is
1728+
The GetStateEnabled method returns whether a `Enum.HumanoidStateType` is
17261729
enabled for the `Class.Humanoid`.
17271730
17281731
The humanoid state describes the activity the humanoid is currently doing.
@@ -1760,7 +1763,7 @@ methods:
17601763
summary: |
17611764
Returns a table of the Humanoid's statuses, and custom statuses.
17621765
description: |
1763-
The GetStatuses function returns a table of the Humanoid's statuses, and
1766+
The GetStatuses method returns a table of the Humanoid's statuses, and
17641767
custom statuses.
17651768
code_samples:
17661769
parameters: []
@@ -1781,7 +1784,7 @@ methods:
17811784
summary: |
17821785
Returns boolean based on if custom statuses exist.
17831786
description: |
1784-
The HasCustomStatus function returns boolean based on if custom statuses
1787+
The HasCustomStatus method returns boolean based on if custom statuses
17851788
exist.
17861789
code_samples:
17871790
parameters:
@@ -1806,7 +1809,7 @@ methods:
18061809
summary: |
18071810
Returns a boolean based on if a status exists.
18081811
description: |
1809-
The HasStatus function returns a boolean based on if a status exists.
1812+
The HasStatus method returns a boolean based on if a status exists.
18101813
code_samples:
18111814
parameters:
18121815
- name: status
@@ -1831,7 +1834,7 @@ methods:
18311834
Loads an `Class.Animation` onto a `Class.Humanoid`, returning an
18321835
`Class.AnimationTrack` that can be used for playback.
18331836
description: |
1834-
This function loads an `Class.Animation` onto a `Class.Humanoid`,
1837+
This method loads an `Class.Animation` onto a `Class.Humanoid`,
18351838
returning an `Class.AnimationTrack` that can be used for playback.
18361839
code_samples:
18371840
parameters:
@@ -1857,10 +1860,10 @@ methods:
18571860
summary: |
18581861
Causes the `Class.Humanoid` to walk in the given direction.
18591862
description: |
1860-
This function causes the `Class.Humanoid` to walk in the given
1863+
This method causes the `Class.Humanoid` to walk in the given
18611864
`Datatype.Vector3` direction.
18621865
1863-
By default, the direction is in world terms, but If the `relativeToCamera`
1866+
By default, the direction is in world terms, but if the `relativeToCamera`
18641867
parameter is `true`, the direction is relative to the `Datatype.CFrame` of
18651868
the `Class.Workspace.CurrentCamera|CurrentCamera`. As the negative **Z**
18661869
direction is considered "forwards" in Roblox, the following code will make
@@ -1871,14 +1874,14 @@ methods:
18711874
humanoid:Move(Vector3.new(0, 0, -1), true)
18721875
```
18731876
1874-
When this function is called, the `Class.Humanoid` will move until the
1875-
function is called again. However, if the default control scripts are
1876-
being used, this function will be overwritten when called on player
1877+
When this method is called, the `Class.Humanoid` will move until the
1878+
method is called again. However, if the default control scripts are
1879+
being used, this method will be overwritten when called on player
18771880
`Class.Player.Character|Characters`. This can be avoided by either not
18781881
using the default control scripts, or calling this function every frame
18791882
using `Class.RunService:BindToRenderStep()` (see example).
18801883
1881-
This function can be called on the server, but this should only be done
1884+
This method can be called on the server, but this should only be done
18821885
when the server has
18831886
[network ownership](../../../physics/network-ownership.md) of the
18841887
humanoid's assembly.
@@ -1914,7 +1917,7 @@ methods:
19141917
setting the `Class.Humanoid.WalkToPoint` and `Class.Humanoid.WalkToPart`
19151918
properties.
19161919
description: |
1917-
This function causes the `Class.Humanoid` to attempt to walk to the given
1920+
This method causes the `Class.Humanoid` to attempt to walk to the given
19181921
location by setting the `Class.Humanoid.WalkToPoint` and
19191922
`Class.Humanoid.WalkToPart` properties.
19201923
@@ -1975,11 +1978,11 @@ methods:
19751978
summary: |
19761979
Removes all `Class.Accessory` objects worn by the humanoid's parent.
19771980
description: |
1978-
This function removes all `Class.Accessory` objects worn by the humanoid's
1981+
This method removes all `Class.Accessory` objects worn by the humanoid's
19791982
parent. For player `Class.Player.Character|Characters`, this will remove
19801983
all hats and other accessories.
19811984
1982-
This function removes `Class.Accessory` object by calling
1985+
This method removes `Class.Accessory` object by calling
19831986
`Class.Instance:Destroy()` on them, meaning the
19841987
`Class.Instance.Parent|Parent` of the accessories are set to `nil` and
19851988
locked.
@@ -2003,7 +2006,7 @@ methods:
20032006
summary: |
20042007
Removes the defined custom status from the Status model in the Humanoid..
20052008
description: |
2006-
The RemoveCustomStatus function removes the defined custom status from the
2009+
The RemoveCustomStatus method removes the defined custom status from the
20072010
Status model in the Humanoid..
20082011
code_samples:
20092012
parameters:
@@ -2028,7 +2031,7 @@ methods:
20282031
summary: |
20292032
Removes the defined status from the Status model in the Humanoid.
20302033
description: |
2031-
The RemoveStatus function removes the defined status from the Status model
2034+
The RemoveStatus method removes the defined status from the Status model
20322035
in the Humanoid.
20332036
code_samples:
20342037
parameters:
@@ -2056,10 +2059,10 @@ methods:
20562059
Dynamically replaces a R15/Rthro limb part in a Humanoid with a different
20572060
part. The part is automatically scaled as normal.
20582061
2059-
This function is useful for modifying characters during gameplay or
2060-
building characters from a base rig. The related function
2062+
This method is useful for modifying characters during gameplay or
2063+
building characters from a base rig. The related method
20612064
`Class.Humanoid:GetBodyPartR15()|GetBodyPartR15` can come in handy when
2062-
using this function.
2065+
using this method.
20632066
20642067
The name of the part passed in should match with the name of the
20652068
BodyPartR15 Enum passed in.
@@ -2090,7 +2093,7 @@ methods:
20902093
Sets whether a given `Enum.HumanoidStateType` is enabled for the
20912094
`Class.Humanoid`.
20922095
description: |
2093-
This function sets whether a given `Enum.HumanoidStateType` is enabled for
2096+
This method sets whether a given `Enum.HumanoidStateType` is enabled for
20942097
the `Class.Humanoid`. When a particular `Enum.HumanoidStateType` is
20952098
disabled, the `Class.Humanoid` can never enter that state. This is true
20962099
regardless if the attempt to change state is made using
@@ -2126,10 +2129,10 @@ methods:
21262129
Lowers the `Class.Humanoid.Health` of the `Class.Humanoid` by the given
21272130
_amount_ if it is not protected by a `Class.ForceField`.
21282131
description: |
2129-
This function lowers the `Class.Humanoid.Health` of the `Class.Humanoid`
2132+
This method lowers the `Class.Humanoid.Health` of the `Class.Humanoid`
21302133
by the given _amount_ if it is not protected by a `Class.ForceField`
21312134
2132-
This function accepts negative values for the _amount_ parameter. This
2135+
This method accepts negative values for the _amount_ parameter. This
21332136
will increase the humanoid's `Class.Humanoid.Health`. However this will
21342137
only have an effect if no `Class.ForceField` is present.
21352138
@@ -2147,7 +2150,7 @@ methods:
21472150
21482151
To do damage to a `Class.Humanoid` irrespective of any
21492152
`Class.ForceField|ForceFields` present, set `Class.Humanoid.Health`
2150-
directly.
2153+
directly using `Humanoid.Health = AMOUNT`.
21512154
21522155
For more information on how `Class.ForceField|ForceFields` protect
21532156
`Class.Humanoid|Humanoids` see the `Class.ForceField` page
@@ -2172,16 +2175,16 @@ methods:
21722175
summary: |
21732176
Unequips any `Class.Tool` currently equipped by the `Class.Humanoid`.
21742177
description: |
2175-
This function unequips any `Class.Tool` currently equipped by the
2178+
This method unequips any `Class.Tool` currently equipped by the
21762179
`Class.Humanoid`
21772180
21782181
The unequipped `Class.Tool` will be parented to the `Class.Backpack` of
21792182
the `Class.Player` associated with the `Class.Humanoid`.
21802183
2181-
If no `Class.Tool` is equipped, this function will do nothing.
2184+
If no `Class.Tool` is equipped, this method will do nothing.
21822185
21832186
Although `Class.Tool|Tools` can be equipped by NPCs (Non Player
2184-
Characters), this function only works on `Class.Humanoid|Humanoids` with a
2187+
Characters), this method only works on `Class.Humanoid|Humanoids` with a
21852188
corresponding `Class.Player`. This is because a `Class.Backpack` object is
21862189
required to parent the unequipped `Class.Tool` to.
21872190
@@ -2215,8 +2218,8 @@ methods:
22152218
tags:
22162219
- Deprecated
22172220
deprecation_message: |
2218-
This deprecated function is a variant of `Class.Humanoid:LoadAnimation()`
2219-
which should be used instead.
2221+
This deprecated method is a variant of `Class.Humanoid:LoadAnimation()`.
2222+
`Class.Animator:LoadAnimation()` should be used instead.
22202223
security: None
22212224
thread_safety: Unsafe
22222225
capabilities: []
@@ -2236,7 +2239,7 @@ methods:
22362239
tags:
22372240
- Deprecated
22382241
deprecation_message: |
2239-
This deprecated function is a variant of `Class.Humanoid:TakeDamage()`
2242+
This deprecated method is a variant of `Class.Humanoid:TakeDamage()`,
22402243
which should be used instead.
22412244
security: None
22422245
thread_safety: Unsafe
@@ -2247,17 +2250,17 @@ methods:
22472250
Makes the character's look match that of the passed in
22482251
`Class.HumanoidDescription`.
22492252
description: |
2250-
This yielding function makes the character's look match that of the passed
2253+
This yielding method makes the character's look match that of the passed
22512254
in `Class.HumanoidDescription`. A copy of the passed
22522255
`Class.HumanoidDescription` is cached as the `Class.HumanoidDescription`
22532256
for the `Class.Humanoid`.
22542257
2255-
This function is optimized through making the assumption that only this
2256-
function is used to change the appearance of the character, and no changes
2258+
This method is optimized through making the assumption that only this
2259+
method is used to change the appearance of the character, and no changes
22572260
are made through other means between calls. If changes are made to the
2258-
character between calls. Then this function may not make the character
2261+
character between calls, then this method may not make the character
22592262
reflect the passed in `Class.HumanoidDescription` accurately. If you want
2260-
to use this function in conjunction with other means of updating the
2263+
to use this method in conjunction with other means of updating the
22612264
character, `Class.Humanoid:ApplyDescriptionReset()` will always ensure the
22622265
character reflects the passed in `Class.HumanoidDescription`.
22632266
@@ -2300,12 +2303,12 @@ methods:
23002303
Makes the character's look match that of the passed in
23012304
`Class.HumanoidDescription`, even after external changes.
23022305
description: |
2303-
This yielding function makes the character's look match that of the passed
2306+
This yielding method makes the character's look match that of the passed
23042307
in `Class.HumanoidDescription`, even after external changes. A copy of the
23052308
passed `Class.HumanoidDescription` is cached as the
23062309
`Class.HumanoidDescription` for the `Class.Humanoid`.
23072310
2308-
This function will always ensure the character reflects the passed in
2311+
This method will always ensure the character reflects the passed in
23092312
`Class.HumanoidDescription`, even if changes have been made to the
23102313
character not using the `Class.HumanoidDescription` system (for example
23112314
not using `Class.Humanoid:ApplyDescriptionReset()|ApplyDescriptionReset()`
@@ -2341,7 +2344,7 @@ methods:
23412344
Plays emotes and returns if was successfully ran.
23422345
description: |
23432346
If the emote could not be played because the emoteName is not found in the
2344-
HumanoidDescription this API will give an error. The API will return true
2347+
HumanoidDescription, this method will give an error. The method will return true
23452348
to indicate that the emote was played successfully.
23462349
code_samples:
23472350
parameters:

0 commit comments

Comments
 (0)