TryToEnable - ReferenceAlias

From the CreationKit Wiki
Revision as of 16:25, 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 enable 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 Enable() on them without having to test for a reference being present first.

Syntax

bool Function TryToEnable()
	ObjectReference Ref = GetReference()
	if Ref
		Ref.Enable()
		Return True
	EndIf
	Return False
EndFunction

Parameters

None

Return Value

True if the reference was enabled, false if there was no reference to enable

Examples

; Enable the cool object
if CoolAlias.TryToEnable()
  Debug.Trace("Cool object enabled!")
else
  Debug.Trace("No cool object exists...")
endIf

See Also