TryToEnableNoWait - ReferenceAlias

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: ReferenceAlias Script

This is a convenient way to enable a reference (without waiting on it to finish enabling) 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 EnableNoWait() on them without having to test for a reference being present first.

Syntax[edit | edit source]

bool Function TryToEnableNoWait()
	ObjectReference Ref = GetReference()
	if Ref
		Ref.EnableNoWait()
		Return True
	EndIf
	Return False
EndFunction

Return Value[edit | edit source]

True if the object was requested to enable, false if no object was there to be enabled.

Examples[edit | edit source]

; Attempt to enable the cool thing without waiting on it to finish
CoolAlias.TryToEnableNoWait()

Notes:[edit | edit source]

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