InterruptCast - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Interrupts and stops any spell-casting this object might be doing.

Syntax

Function InterruptCast() native

Parameters

None.

Return Value

None.

Examples

; Stop this flame trap from casting
FlameTrap.InterruptCast()

;This example script extends ActiveMagicEffect
 
float Property max auto
 
Event OnEffectStart(Actor akTarget, Actor akCaster)
 
	; Let's say you want to restore your health through a script.
	If (Game.GetPlayer() == akTarget)
		If (akTarget.GetActorValuePercentage("health") >= max)
			akTarget.InterruptCast()
			Debug.Notification("You cannot cast this spell at this time")
			; Because your health is at 100% (represented by 1.0) this casting will be interrupted until the condition is met.
		ElseIf (akTarget.GetActorValuePercentage("health") <= max)
			akTarget.RestoreAV("health", 300)
		EndIf
	EndIf
 
EndEvent

See Also