Difference between revisions of "IsReference"

From GECK

(Automated import of articles)
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''IsReference'''
 
 
{{Function
 
{{Function
 
  |origin = FOSE1
 
  |origin = FOSE1
  |summary = Returns 1 if the passed refVar stores a reference.
+
  |summary = Returns True (1) if the passed ref variable stores a reference. Particularly useful for validation in cases where a non reference might cause a script to crash.
 
  |name = IsReference
 
  |name = IsReference
  |returnType = int
+
  |returnType = bool
 
  |arguments =  
 
  |arguments =  
 
   {{FunctionArgument
 
   {{FunctionArgument
Line 11: Line 10:
 
   }}
 
   }}
 
}}
 
}}
 +
==Example==
 +
<pre>
 +
if IsReference RefVar
 +
    ; it is safe to proceed
 +
endif
 +
</pre>
 +
 +
==Notes==
 +
*IsReference ALWAYS returns true in a script block that has the CO on (script compiler override).
 +
 +
==See Also==
 +
*[[IsFormValid]]
 +
*[[TypeOf]]
 +
*[[GetType]]
 +
*[[IsPersistent]]
 +
[[Category:Debugging]]
 
[[Category:Functions_(FOSE)]]
 
[[Category:Functions_(FOSE)]]

Latest revision as of 12:26, 20 February 2017

A function added by the Fallout Script Extender.

Description

Returns True (1) if the passed ref variable stores a reference. Particularly useful for validation in cases where a non reference might cause a script to crash.

Syntax

(bool) IsReference reference:ref

Example

if IsReference RefVar
    ; it is safe to proceed
endif

Notes

  • IsReference ALWAYS returns true in a script block that has the CO on (script compiler override).

See Also

Personal tools