TrapSoul - Actor

From the CreationKit Wiki
Revision as of 13:21, 12 October 2010 by imported>Jlundin
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Actor Script

Attempts to trap the soul of the target actor in a soul gem in the inventory of the calling actor. Returns success/failure.

Syntax[edit | edit source]

bool Function TrapSoul(Actor akTarget) native

Parameters[edit | edit source]

  • akTarget: The target actor being soul-trapped.

Return Value[edit | edit source]

True if the actor successfully trapped the given actor's soul. False, otherwise.

Examples[edit | edit source]

; Have the player try to trap the soul of elvis
if Game.GetPlayer().TrapSoul(Elvis)
  Debug.Trace("Time to power up rock and roll!")
endIf

See Also[edit | edit source]