TrapSoul - Actor | Fallout 4

Found in:

Vanilla
F4SE

boolfunctionTrapSoul(ActorakTarget)Native

Description

Wiki Description

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

Documentation Comment

Returns whether the actor can trap the soul of the given actor.

Caveats

Parameters

ActorakTarget

CK Wiki Description

The target actor being soul-trapped.

Examples

; 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; 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

Auto-Generated Example

Actor myActor__akTarget

bool returnedValue = myActor__toCallFunctionOn.TrapSoul(myActor__akTarget)

Actor

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki