Difference between revisions of "TryToKill - ReferenceAlias"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
imported>Thingy Person
 
Line 8: Line 8:
<source lang="papyrus">
<source lang="papyrus">
bool Function TryToKill()
bool Function TryToKill()
Actor ActorRef = GetActorReference()
if ActorRef
ActorRef.Kill()
Return True
EndIf
Return False
EndFunction
</source>
</source>



Latest revision as of 16:28, 29 June 2013

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[edit | edit source]

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

Parameters[edit | edit source]

None

Return Value[edit | edit source]

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

Examples[edit | edit source]

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

See Also[edit | edit source]