TryToKill - ReferenceAlias

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

Return Value

True if Kill was called on the actor, 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

Notes:

(AliasTryFunctions == TRUE) is NOT an accurate reflection of (AliasRef == HasExpectedResults) OR (Alias == HasNewOrNoValue)

• IS a reflection that the alias met the criteria to have the functions called upon them

• Many, if not most of these functions are external dispatch to other scripts and do not wait for expected results
• True means alias had valid reference, and is queued to run your desired function on it, or POSSIBLY already has
• False means the alias does not have a reference, or does not have a reference of the appropriate type
• Try functions do NOT return false if the function called(AddToFaction(), Clear() Etc) go on to fail for any reason

See Also

• ReferenceAlias Script
• Kill - Actor