Difference between revisions of "TryToDisable - ReferenceAlias"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Scornett
m (Reverted edits by Scornett-Bot (talk) to last revision by Jlundin)
 
imported>Thingy Person
 
Line 9: Line 9:
<source lang="papyrus">
<source lang="papyrus">
bool Function TryToDisable()
bool Function TryToDisable()
ObjectReference Ref = GetReference()
if Ref
Ref.Disable()
Return True
EndIf
Return False
EndFunction
</source>
</source>



Latest revision as of 16:24, 29 June 2013

Member of: ReferenceAlias Script

This is a convenient way to disable a reference in an alias without calling GetReference() 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 Disable() on them without having to test for a reference being present first.

Syntax[edit | edit source]

bool Function TryToDisable()
	ObjectReference Ref = GetReference()
	if Ref
		Ref.Disable()
		Return True
	EndIf
	Return False
EndFunction

Parameters[edit | edit source]

None

Return Value[edit | edit source]

True if the alias contained a reference and it was disabled, false if the alias didn't contain a reference.

Examples[edit | edit source]

; Disable the alias
if BarrierAlias.TryToDisable()
  Debug.Trace("Barrier disabled")
else
  Debug.Trace("No barrier to disable")
endIf

See Also[edit | edit source]