TryToKill - ReferenceAlias

From the CreationKit Wiki
Revision as of 16:28, 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 kill an actor in an alias 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 Kill() on them without having to test for an actor being present first.

Syntax

bool Function TryToKill()
	Actor ActorRef = GetActorReference()
	if ActorRef
		ActorRef.Kill()
		Return True
	EndIf
	Return False
EndFunction

Parameters

None

Return Value

True if the actor was killed, false if no actor was there to be killed

Examples

; Try to kill the bandit
if BanditAlias.TryToKill()
  Debug.Trace("Bandit killed!")
else
  Debug.Trace("No banded to kill...")
endIf

See Also