Enable - ObjectReference

From the CreationKit Wiki
Revision as of 19:06, 4 July 2015 by imported>Bug64 (Added a note on enabling an Actor)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: ObjectReference Script

Enables this reference, popping it into existance. This function is latent and will wait for the enable to happen.

Syntax

Function Enable(bool abFadeIn = false) native

Parameters

  • abFadeIn: Whether to fade in the object or not. Function won't return until object is faded in. If this is an enable parent the children will not be faded.
    • Default: False

Return Value

None.

Examples

; Enables the reference, popping it in
TempReference.Enable()


; Enables the reference, fading it in
TempReference.Enable(true)

Notes

  • Small objects will never fade.
  • Enabling an Actor will cause the actor to snap back to the location it had when it was disabled
  • Children of an enable parent will not fade and will simply pop into existence when the parent object has finished fading.
  • Lights will never fade. In order for an enable/disable function to work on a light, the enable() function must be left blank for the light to be enabled or disabled.

See Also