Difference between revisions of "SetHeight - 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 Sets the body height multiplier of this actor. (This function require...")
 
imported>Wafflesalot
(→‎Notes: Added Note on Bounding boxes)
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
;Increases the players size by 1.5x
;Increases the players size by 0.5x
Game.GetPlayer().GetActorBase().SetHeight(1.5)
Game.GetPlayer().GetActorBase().SetHeight(1.5)
</source>
</source>
Line 23: Line 23:
*To update the Actors size after running this function, the function [[QueueNiNodeUpdate - Actor|QueueNiNodeUpdate]] must be used.
*To update the Actors size after running this function, the function [[QueueNiNodeUpdate - Actor|QueueNiNodeUpdate]] must be used.


*This Function does not update Collision geometry, nor camera if used on the player.
* When animation driven, Running, Walking, Sneaking and Sprinting will all scale with the actor, for example if the actor is 0.5x their original size then they will move approximately half speed.


*The Actors Bounding box will not be changed with this function.


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

Latest revision as of 05:38, 1 March 2013

SKSE Member of: ActorBase Script

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

Syntax[edit | edit source]

Function SetHeight(float height) native

Parameter[edit | edit source]

  • height - Sets the Actors body height multiplier.

Examples[edit | edit source]

;Increases the players size by 0.5x
Game.GetPlayer().GetActorBase().SetHeight(1.5)

Notes[edit | edit source]

  • To update the Actors size after running this function, the function QueueNiNodeUpdate must be used.
  • When animation driven, Running, Walking, Sneaking and Sprinting will all scale with the actor, for example if the actor is 0.5x their original size then they will move approximately half speed.
  • The Actors Bounding box will not be changed with this function.

See Also[edit | edit source]