Skip to content

calcRunSpeed⚓︎

One of the movement events, calcRunSpeed is used when calculating when the player is running, but not swimming or flying.

The movement event flow is described below:

--- @param e calcRunSpeedEventData
local function calcRunSpeedCallback(e)
end
event.register(tes3.event.calcRunSpeed, calcRunSpeedCallback)

Tip

An event can be claimed by setting e.claim to true, or by returning false from the callback. Claiming the event prevents any lower priority callbacks from being called.

Event Data⚓︎

  • mobile (tes3mobileActor): Read-only. The mobile actor whose speed is being calculated.
  • reference (tes3reference): Read-only. mobile’s related reference.
  • speed (number): The previous speed calculated, starting with the base engine values.
  • type (number): Read-only. The type of movement that was calculated. This is always 2 for this event.

calcMoveSpeedcalcWalkSpeedcalcRunSpeedcalcFlySpeedcalcSwimSpeedcalcSwimRunSpeed