RemoveScriptPackage

Syntax

[ActorRefID.]RemoveScriptPackage

Removes the currently running script package from the calling actor. Only necessary if you added a script package which was set to run indefinitely. When the script package is removed, the actor will automatically choose a new package.

Example

; from MS45DarMaScript
if getIsCurrentPackage MS45DarMaPrisonerGreetPlayer == 1
  If getInSameCell player == 0
    removeScriptPackage
  endif
endif

Notes

• Removing a script package on an actor that has no script package can cause the script to stop running on all instances of that actor. It is preferable to use a package(s) attached to the actor in its AI definition with one or more conditions specified.
  • Also, it will prevent the player starting or acquiring new packages or procedures which are triggered by functions. For instance, calling forceFlee while removeScriptPackage is being called will prevent the fleeing behavior from triggering.
  • Conversely, calling removeScriptPackage will stop and remove the actor's current package/procedure had it been triggered by a function. For an example, calling the function on a fleeing actor will cancel the flee procedure.
• Parameter usage is accepted by the script compiler, but has no effect during run-time.
• This function cannot be used to remove Editor-added packages.

See Also

• AddScriptPackage
• EvaluatePackage