Skip to content

Commit 601e2c9

Browse files
authored
Little Writing Changes to Humanoid Page (#1006)
## Changes <!-- Please summarize your changes. --> In short, I made some changes to the Humanoid page, changing Function word to Method in methods, etc. I'm aware that the description of ChangeState() is long, but I believe it's easier for beginners to understand. <!-- Please link to any applicable information (forum posts, bug reports, etc.). --> I have done this Push before, I am just making some changes. ## Checks By submitting your pull request for review, you agree to the following: - [✅] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [✅] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [✅] To the best of my knowledge, all proposed changes are accurate. ---------
1 parent b6bb353 commit 601e2c9

File tree

1 file changed

+59
-58
lines changed

1 file changed

+59
-58
lines changed

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

Lines changed: 59 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,12 @@ 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`,
1444-
but the NetworkOwner 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
1443+
[network ownership](../../../physics/network-ownership.md) of the `Class.Player.Character`.
1444+
Alternatively, you can call this method from a server-side `Class.Script`, but the
1445+
server must have network ownership of the player character.
1446+
14461447
See also `Class.Humanoid:SetStateEnabled()` to enable or disable a
14471448
particular state, and `Class.Humanoid:GetState()` to get the current
14481449
humanoid state.
@@ -1467,7 +1468,7 @@ methods:
14671468
summary: |
14681469
Makes the `Class.Humanoid` equip the given `Class.Tool`.
14691470
description: |
1470-
This function makes the `Class.Humanoid` equip the given `Class.Tool`.
1471+
This method makes the `Class.Humanoid` equip the given `Class.Tool`.
14711472
14721473
The below example would cause a `Class.Player` to equip a tool in
14731474
`Class.Workspace` named _'Tool'_.
@@ -1488,13 +1489,13 @@ methods:
14881489
end
14891490
```
14901491
1491-
When this function is called, the `Class.Humanoid` will first
1492+
When this method is called, the `Class.Humanoid` will first
14921493
automatically unequip all `Class.Tool|Tools` that it currently has
14931494
equipped.
14941495
14951496
Although they will be equipped, `Class.Tool|Tools` for which
14961497
`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
1498+
handle, regardless if this method is used to equip them or not.
14981499
14991500
See also:
15001501
@@ -1520,7 +1521,7 @@ methods:
15201521
Returns an array of `Class.Accessory` objects that the humanoid's parent
15211522
is currently wearing.
15221523
description: |
1523-
This function returns an array of `Class.Accessory` objects that the
1524+
This method returns an array of `Class.Accessory` objects that the
15241525
humanoid's parent is currently wearing. All such `Class.Accessory` objects
15251526
will be included, regardless of whether they're attached or not.
15261527
@@ -1548,10 +1549,10 @@ methods:
15481549
Returns a copy of the humanoid's cached `Class.HumanoidDescription` which
15491550
describes its current look.
15501551
description: |
1551-
This function returns a copy of the humanoid's cached
1552+
This method returns a copy of the humanoid's cached
15521553
`Class.HumanoidDescription` which describes its current look. This can be
15531554
used to quickly determine a character's look and to assign their look to
1554-
other characters using the `Class.Humanoid:ApplyDescription()` function.
1555+
other characters using the `Class.Humanoid:ApplyDescription()` method.
15551556
15561557
#### See Also
15571558
@@ -1576,13 +1577,13 @@ methods:
15761577
writeCapabilities: []
15771578
- name: Humanoid:GetBodyPartR15
15781579
summary: |
1579-
Pass a body part to this function (the body part should be a sibling of
1580+
Pass a body part to this method (the body part should be a sibling of
15801581
Humanoid, and a child of a Model) to get the `Enum.BodyPartR15` of the
15811582
`Class.Part`.
15821583
description: |
1583-
This function returns what `Enum.BodyPartR15` a `Class.Part` is, or
1584+
This method returns what `Enum.BodyPartR15` a `Class.Part` is, or
15841585
`Enum.BodyPartR15.Unknown` if the part is not an R15 body part. This
1585-
function allows developers to retrieve player body parts independent of
1586+
method allows developers to retrieve player body parts independent of
15861587
what the actual body part names are, instead returning an enum.
15871588
15881589
It can be used in conjunction with `Class.Humanoid:ReplaceBodyPartR15()`.
@@ -1592,7 +1593,7 @@ methods:
15921593
developers can either perform some gameplay action or replace that part
15931594
with some other part - perhaps showing damage.
15941595
1595-
This function can be useful for games where hit location is important. For
1596+
This method can be useful for games where hit location is important. For
15961597
example, it can be used to determine if a player is hit in the leg and
15971598
then slow them down based on the injury.
15981599
code_samples:
@@ -1618,7 +1619,7 @@ methods:
16181619
Returns the `Enum.Limb` enum that is associated with the given
16191620
`Class.Part`.
16201621
description: |
1621-
This function returns the `Enum.Limb` enum that is associated with the
1622+
This method returns the `Enum.Limb` enum that is associated with the
16221623
given `Class.Part`. It works for both R15 and R6 rigs, for example:
16231624
16241625
```lua
@@ -1671,12 +1672,12 @@ methods:
16711672
Returns an array of all `Class.AnimationTrack|AnimationTracks` that are
16721673
currently being played on the `Class.Humanoid`.
16731674
description: |
1674-
This function returns an array of all
1675+
This method returns an array of all
16751676
`Class.AnimationTrack|AnimationTracks` that are currently being played on
1676-
the `Class.Humanoid`.c A typical use for this function is stopping
1677+
the `Class.Humanoid`. A typical use for this method is stopping
16771678
currently playing tracks using `Class.AnimationTrack:Stop()`.
16781679
1679-
Beware that this function will not return
1680+
Beware that this method will not return
16801681
`Class.AnimationTrack|AnimationTracks` that have loaded but are **not
16811682
playing**. If you want to track these you will need to index them
16821683
manually.
@@ -1697,7 +1698,7 @@ methods:
16971698
summary: |
16981699
Returns the humanoid's current `Enum.HumanoidStateType`.
16991700
description: |
1700-
This function returns the humanoid's current `Enum.HumanoidStateType`,
1701+
This method returns the humanoid's current `Enum.HumanoidStateType`,
17011702
describing the activity the `Class.Humanoid` is currently doing, such as
17021703
jumping or swimming.
17031704
@@ -1722,7 +1723,7 @@ methods:
17221723
Returns whether a `Enum.HumanoidStateType` is enabled for the
17231724
`Class.Humanoid`.
17241725
description: |
1725-
The GetStateEnabled function returns whether a `Enum.HumanoidStateType` is
1726+
The GetStateEnabled method returns whether a `Enum.HumanoidStateType` is
17261727
enabled for the `Class.Humanoid`.
17271728
17281729
The humanoid state describes the activity the humanoid is currently doing.
@@ -1760,7 +1761,7 @@ methods:
17601761
summary: |
17611762
Returns a table of the Humanoid's statuses, and custom statuses.
17621763
description: |
1763-
The GetStatuses function returns a table of the Humanoid's statuses, and
1764+
The GetStatuses method returns a table of the Humanoid's statuses, and
17641765
custom statuses.
17651766
code_samples:
17661767
parameters: []
@@ -1781,7 +1782,7 @@ methods:
17811782
summary: |
17821783
Returns boolean based on if custom statuses exist.
17831784
description: |
1784-
The HasCustomStatus function returns boolean based on if custom statuses
1785+
The HasCustomStatus method returns boolean based on if custom statuses
17851786
exist.
17861787
code_samples:
17871788
parameters:
@@ -1806,7 +1807,7 @@ methods:
18061807
summary: |
18071808
Returns a boolean based on if a status exists.
18081809
description: |
1809-
The HasStatus function returns a boolean based on if a status exists.
1810+
The HasStatus method returns a boolean based on if a status exists.
18101811
code_samples:
18111812
parameters:
18121813
- name: status
@@ -1831,7 +1832,7 @@ methods:
18311832
Loads an `Class.Animation` onto a `Class.Humanoid`, returning an
18321833
`Class.AnimationTrack` that can be used for playback.
18331834
description: |
1834-
This function loads an `Class.Animation` onto a `Class.Humanoid`,
1835+
This method loads an `Class.Animation` onto a `Class.Humanoid`,
18351836
returning an `Class.AnimationTrack` that can be used for playback.
18361837
code_samples:
18371838
parameters:
@@ -1857,10 +1858,10 @@ methods:
18571858
summary: |
18581859
Causes the `Class.Humanoid` to walk in the given direction.
18591860
description: |
1860-
This function causes the `Class.Humanoid` to walk in the given
1861+
This method causes the `Class.Humanoid` to walk in the given
18611862
`Datatype.Vector3` direction.
18621863
1863-
By default, the direction is in world terms, but If the `relativeToCamera`
1864+
By default, the direction is in world terms, but if the `relativeToCamera`
18641865
parameter is `true`, the direction is relative to the `Datatype.CFrame` of
18651866
the `Class.Workspace.CurrentCamera|CurrentCamera`. As the negative **Z**
18661867
direction is considered "forwards" in Roblox, the following code will make
@@ -1871,14 +1872,14 @@ methods:
18711872
humanoid:Move(Vector3.new(0, 0, -1), true)
18721873
```
18731874
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
1875+
When this method is called, the `Class.Humanoid` will move until the
1876+
method is called again. However, if the default control scripts are
1877+
being used, this method will be overwritten when called on player
18771878
`Class.Player.Character|Characters`. This can be avoided by either not
18781879
using the default control scripts, or calling this function every frame
18791880
using `Class.RunService:BindToRenderStep()` (see example).
18801881
1881-
This function can be called on the server, but this should only be done
1882+
This method can be called on the server, but this should only be done
18821883
when the server has
18831884
[network ownership](../../../physics/network-ownership.md) of the
18841885
humanoid's assembly.
@@ -1914,7 +1915,7 @@ methods:
19141915
setting the `Class.Humanoid.WalkToPoint` and `Class.Humanoid.WalkToPart`
19151916
properties.
19161917
description: |
1917-
This function causes the `Class.Humanoid` to attempt to walk to the given
1918+
This method causes the `Class.Humanoid` to attempt to walk to the given
19181919
location by setting the `Class.Humanoid.WalkToPoint` and
19191920
`Class.Humanoid.WalkToPart` properties.
19201921
@@ -1975,11 +1976,11 @@ methods:
19751976
summary: |
19761977
Removes all `Class.Accessory` objects worn by the humanoid's parent.
19771978
description: |
1978-
This function removes all `Class.Accessory` objects worn by the humanoid's
1979+
This method removes all `Class.Accessory` objects worn by the humanoid's
19791980
parent. For player `Class.Player.Character|Characters`, this will remove
19801981
all hats and other accessories.
19811982
1982-
This function removes `Class.Accessory` object by calling
1983+
This method removes `Class.Accessory` object by calling
19831984
`Class.Instance:Destroy()` on them, meaning the
19841985
`Class.Instance.Parent|Parent` of the accessories are set to `nil` and
19851986
locked.
@@ -2003,7 +2004,7 @@ methods:
20032004
summary: |
20042005
Removes the defined custom status from the Status model in the Humanoid..
20052006
description: |
2006-
The RemoveCustomStatus function removes the defined custom status from the
2007+
The RemoveCustomStatus method removes the defined custom status from the
20072008
Status model in the Humanoid..
20082009
code_samples:
20092010
parameters:
@@ -2028,7 +2029,7 @@ methods:
20282029
summary: |
20292030
Removes the defined status from the Status model in the Humanoid.
20302031
description: |
2031-
The RemoveStatus function removes the defined status from the Status model
2032+
The RemoveStatus method removes the defined status from the Status model
20322033
in the Humanoid.
20332034
code_samples:
20342035
parameters:
@@ -2056,10 +2057,10 @@ methods:
20562057
Dynamically replaces a R15/Rthro limb part in a Humanoid with a different
20572058
part. The part is automatically scaled as normal.
20582059
2059-
This function is useful for modifying characters during gameplay or
2060-
building characters from a base rig. The related function
2060+
This method is useful for modifying characters during gameplay or
2061+
building characters from a base rig. The related method
20612062
`Class.Humanoid:GetBodyPartR15()|GetBodyPartR15` can come in handy when
2062-
using this function.
2063+
using this method.
20632064
20642065
The name of the part passed in should match with the name of the
20652066
BodyPartR15 Enum passed in.
@@ -2090,7 +2091,7 @@ methods:
20902091
Sets whether a given `Enum.HumanoidStateType` is enabled for the
20912092
`Class.Humanoid`.
20922093
description: |
2093-
This function sets whether a given `Enum.HumanoidStateType` is enabled for
2094+
This method sets whether a given `Enum.HumanoidStateType` is enabled for
20942095
the `Class.Humanoid`. When a particular `Enum.HumanoidStateType` is
20952096
disabled, the `Class.Humanoid` can never enter that state. This is true
20962097
regardless if the attempt to change state is made using
@@ -2126,10 +2127,10 @@ methods:
21262127
Lowers the `Class.Humanoid.Health` of the `Class.Humanoid` by the given
21272128
_amount_ if it is not protected by a `Class.ForceField`.
21282129
description: |
2129-
This function lowers the `Class.Humanoid.Health` of the `Class.Humanoid`
2130+
This method lowers the `Class.Humanoid.Health` of the `Class.Humanoid`
21302131
by the given _amount_ if it is not protected by a `Class.ForceField`
21312132
2132-
This function accepts negative values for the _amount_ parameter. This
2133+
This method accepts negative values for the _amount_ parameter. This
21332134
will increase the humanoid's `Class.Humanoid.Health`. However this will
21342135
only have an effect if no `Class.ForceField` is present.
21352136
@@ -2150,7 +2151,7 @@ methods:
21502151
directly.
21512152
21522153
For more information on how `Class.ForceField|ForceFields` protect
2153-
`Class.Humanoid|Humanoids` see the `Class.ForceField` page
2154+
`Class.Humanoid|Humanoids` see the `Class.ForceField` page.
21542155
code_samples:
21552156
- Humanoid-TakeDamage1
21562157
parameters:
@@ -2172,16 +2173,16 @@ methods:
21722173
summary: |
21732174
Unequips any `Class.Tool` currently equipped by the `Class.Humanoid`.
21742175
description: |
2175-
This function unequips any `Class.Tool` currently equipped by the
2176+
This method unequips any `Class.Tool` currently equipped by the
21762177
`Class.Humanoid`
21772178
21782179
The unequipped `Class.Tool` will be parented to the `Class.Backpack` of
21792180
the `Class.Player` associated with the `Class.Humanoid`.
21802181
2181-
If no `Class.Tool` is equipped, this function will do nothing.
2182+
If no `Class.Tool` is equipped, this method will do nothing.
21822183
21832184
Although `Class.Tool|Tools` can be equipped by NPCs (Non Player
2184-
Characters), this function only works on `Class.Humanoid|Humanoids` with a
2185+
Characters), this method only works on `Class.Humanoid|Humanoids` with a
21852186
corresponding `Class.Player`. This is because a `Class.Backpack` object is
21862187
required to parent the unequipped `Class.Tool` to.
21872188
@@ -2215,8 +2216,8 @@ methods:
22152216
tags:
22162217
- Deprecated
22172218
deprecation_message: |
2218-
This deprecated function is a variant of `Class.Humanoid:LoadAnimation()`
2219-
which should be used instead.
2219+
This deprecated method is a variant of `Class.Humanoid:LoadAnimation()`.
2220+
`Class.Animator:LoadAnimation()` should be used instead.
22202221
security: None
22212222
thread_safety: Unsafe
22222223
capabilities: []
@@ -2236,7 +2237,7 @@ methods:
22362237
tags:
22372238
- Deprecated
22382239
deprecation_message: |
2239-
This deprecated function is a variant of `Class.Humanoid:TakeDamage()`
2240+
This deprecated method is a variant of `Class.Humanoid:TakeDamage()`,
22402241
which should be used instead.
22412242
security: None
22422243
thread_safety: Unsafe
@@ -2247,17 +2248,17 @@ methods:
22472248
Makes the character's look match that of the passed in
22482249
`Class.HumanoidDescription`.
22492250
description: |
2250-
This yielding function makes the character's look match that of the passed
2251+
This yielding method makes the character's look match that of the passed
22512252
in `Class.HumanoidDescription`. A copy of the passed
22522253
`Class.HumanoidDescription` is cached as the `Class.HumanoidDescription`
22532254
for the `Class.Humanoid`.
22542255
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
2256+
This method is optimized through making the assumption that only this
2257+
method is used to change the appearance of the character, and no changes
22572258
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
2259+
character between calls, then this method may not make the character
22592260
reflect the passed in `Class.HumanoidDescription` accurately. If you want
2260-
to use this function in conjunction with other means of updating the
2261+
to use this method in conjunction with other means of updating the
22612262
character, `Class.Humanoid:ApplyDescriptionReset()` will always ensure the
22622263
character reflects the passed in `Class.HumanoidDescription`.
22632264
@@ -2300,12 +2301,12 @@ methods:
23002301
Makes the character's look match that of the passed in
23012302
`Class.HumanoidDescription`, even after external changes.
23022303
description: |
2303-
This yielding function makes the character's look match that of the passed
2304+
This yielding method makes the character's look match that of the passed
23042305
in `Class.HumanoidDescription`, even after external changes. A copy of the
23052306
passed `Class.HumanoidDescription` is cached as the
23062307
`Class.HumanoidDescription` for the `Class.Humanoid`.
23072308
2308-
This function will always ensure the character reflects the passed in
2309+
This method will always ensure the character reflects the passed in
23092310
`Class.HumanoidDescription`, even if changes have been made to the
23102311
character not using the `Class.HumanoidDescription` system (for example
23112312
not using `Class.Humanoid:ApplyDescriptionReset()|ApplyDescriptionReset()`
@@ -2341,7 +2342,7 @@ methods:
23412342
Plays emotes and returns if was successfully ran.
23422343
description: |
23432344
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
2345+
HumanoidDescription, this method will give an error. The method will return true
23452346
to indicate that the emote was played successfully.
23462347
code_samples:
23472348
parameters:

0 commit comments

Comments
 (0)