Difference between revisions of "GetHeight - ActorBase"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Wafflesalot
(Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' ActorBase Script Returns the body height of this actor. (This function requires SKSE) ...")
 
imported>Rasikko
m (→‎Notes: fixed up grammar a bit)
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:
'''SKSE Member of:''' [[ActorBase Script]]
'''SKSE Member of:''' [[ActorBase Script]]


Returns the body height of this actor. (This function requires SKSE)
Returns the body height multiplier of this actor. (This function requires SKSE)


== Syntax ==
== Syntax ==
Line 12: Line 12:


== Return Value ==
== Return Value ==
Returns the body height of this actor.
Returns the body height multiplier of this actor.




Line 18: Line 18:
<source lang="papyrus">
<source lang="papyrus">
Float Height = Game.GetPlayer().GetActorBase().GetHeight()
Float Height = Game.GetPlayer().GetActorBase().GetHeight()
Debug.Trace("The player's, current height is " + Height)
Debug.Trace("The player's, current height multiplier is " + Height)
</source>
</source>
== Notes ==
* This returns the body meshes multiplier so 0.5 would be 50% of the original size of the actor or 1.2 would be 20% larger.
* This Function is different to [[GetHeight - ObjectReference|GetHeight]] in that it is a multiplier and not an actual height.


== See Also ==
== See Also ==
*[[ActorBase Script]]
*[[ActorBase Script]]
*[[SetHeight - ActorBase]]
*[[SetHeight - ActorBase]]

Latest revision as of 02:29, 27 March 2021

SKSE Member of: ActorBase Script

Returns the body height multiplier of this actor. (This function requires SKSE)

Syntax[edit | edit source]

float Function GetHeight() native

Return Value[edit | edit source]

Returns the body height multiplier of this actor.


Examples[edit | edit source]

Float Height = Game.GetPlayer().GetActorBase().GetHeight()
Debug.Trace("The player's, current height multiplier is " + Height)

Notes[edit | edit source]

  • This returns the body meshes multiplier so 0.5 would be 50% of the original size of the actor or 1.2 would be 20% larger.
  • This Function is different to GetHeight in that it is a multiplier and not an actual height.

See Also[edit | edit source]