Difference between revisions of "Disable - ObjectReference"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Scornett
m (Reverted edits by Scornett-Bot (talk) to last revision by Rhavlovick)
 
imported>Chesko
(Undo revision 44203 by Chesko (talk))
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
'''Member of:''' [[ObjectReference Script]]
'''Member of:''' [[ObjectReference Script]]


Disables this reference, fading it out of necessary. This function is latent and will wait for the fade out and/or disable to happen.
Disables this reference, fading it out if necessary. This function is latent and will wait for the fade out and/or disable to happen.


== Syntax ==
== Syntax ==

Latest revision as of 20:57, 26 February 2015

Member of: ObjectReference Script

Disables this reference, fading it out if necessary. This function is latent and will wait for the fade out and/or disable to happen.

Syntax[edit | edit source]

Function Disable(bool abFadeOut = False) native

Parameters[edit | edit source]

  • abFadeOut: Whether to fade the item out or not. If this is an enable parent the children will not be faded.
    • Default: False

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Disables the reference, popping it out
TempReference.Disable()


; Disables the reference, fading it out
TempReference.Disable(true)

Notes[edit | edit source]

  • Small objects will never fade.
  • Children of an enable parent will not fade and will simply pop out of existence when the parent object has finished fading.

See Also[edit | edit source]