TryToStopCombat - ReferenceAlias

From the CreationKit Wiki
Revision as of 16:23, 29 June 2013 by imported>Thingy Person (→‎Syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: ReferenceAlias Script

This is a convenient way to have an actor in an alias stop combat without calling GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call StopCombat() on them without having to test for an actor being present first.

Syntax

bool Function TryToStopCombat()
	Actor ActorRef = GetActorReference()
	if ActorRef
		ActorRef.StopCombat()
		Return True
	EndIf
	Return False
EndFunction

Parameters

None

Return Value

True if the actor stopped combat, false if no actor was there to be stopped

Examples

; Try to get the bandit to stop combat
if BanditAlias.TryToStopCombat()
  Debug.Trace("Bandit stopped combat!")
else
  Debug.Trace("No banded to stop...")
endIf

See Also