TryToDisable - ReferenceAlias

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

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

Parameters

None

Return Value

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

Examples

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

See Also

• ReferenceAlias Script
• TryToDisableNoWait - ReferenceAlias
• TryToEnable - ReferenceAlias
• TryToEnableNoWait - ReferenceAlias
• Disable - ObjectReference