Background for Skyrim SE
Member of the Actor script
boolfunctionPlayIdleWithTarget(IdleakIdle, ObjectReferenceakTarget)Native

Description

Wiki Description

Plays the Idle passed and overrides the actor's target with the given target. If no target is passed, then the idle will use the actor's current target instead.

Documentation Comment

Send an idle to the actor to play, overriding its target with the specified reference


Caveats

CK Wiki - Notes

  • This function will cause the initiating actor to be stuck in combat alert status and unable to come out of it, no matter what combat based functions is called. To fix this, the package running must have the Weapon drawn flag checked. When checked, the alert status is back to normal when the package ends. See source for more info on how to use this in scenes.
  • A weapon needs to be equipped before an idle that normally requires a weapon is played. If you don't have a weapon equipped, the idle will still play, but you will not be able to equip spells/weapons after the idle is complete. You will have to reload. This is similar to the issue above, except you don't need to have the weapon drawn in this case.
  • Actor.DrawWeapon() will prevent this function from firing if one decides to use it to handle the issue above.
  • The ObjectReference.PushActorAway(...) function can interfere with idles. For example, if a weapon has a scripted effect to push an actor away on strike and that weapon is used in a kill move played with PlayIdleWithTarget, the targeted actor may fall from the kill move, get up, and then fall again several seconds later. This behavior can occur even if the targeted actor has been decapitated.

Parameters

IdleakIdle

CK Wiki Description

The Idle to play on this actor.

ObjectReferenceakTarget

CK Wiki Description

The target the actor should play the Idle with - usually used for paired animations.


Examples

; Start Hadvar's backstab paired idle against the thief
if Hadvar.PlayIdleWithTarget(Backstab, Thief)
  Debug.Trace("Hadvar just backstabbed the thief!")
else
  Debug.Trace("Something went wrong")
endIf

Auto-Generated Example

Idle myIdle__akIdle
ObjectReference myObjectReference__akTarget

bool returnedValue = myActor__toCallFunctionOn.PlayIdleWithTarget(myIdle__akIdle, myObjectReference__akTarget)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.