Background for Starfield
Member of the Scene script
eventOnPhaseBegin(intauiPhaseIndex)

Description

Wiki Description

Event called when a scene phase starts.

Documentation Comment

Event received when a phase starts (in parallel with the fragment)


Caveats

CK Wiki - Notes

  • This event runs in parallel with the scene phase begin fragment.
  • Because the scene phase index is an index, it will change if someone changes the phase order in the editor, so make sure to update your event accordingly.

Parameters

intauiPhaseIndex

CK Wiki Description

The phase index that just started.


Examples

Event OnPhaseBegin(int auiPhaseIndex)
  Debug.Trace("Scene phase " + auiPhaseIndex + " has just started")
endEvent

Auto-Generated Example

Scriptname MyCoolScript extends Scene

event OnPhaseBegin(int auiPhaseIndex)
    Debug.trace("Event received - OnPhaseBegin: auiPhaseIndex = " + auiPhaseIndex)
endEvent

Related Pages


Additional References

View this event’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.