Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

ScriptBehaviourUpdateOrder.AppendWorldToPlayerLoop

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static void AppendWorldToPlayerLoop(World world, ref PlayerLoopSystem playerLoop);

Parameters

Parameter Description
world The three top-level system groups from this World will be added to the provided player loop.
playerLoop Existing player loop to modify (e.g. (e.g. PlayerLoop.GetCurrentPlayerLoop())

Description

Add this World's three default top-level system groups to a PlayerLoopSystem object.

This function performs the following modifications to the provided PlayerLoopSystem: - If an instance of InitializationSystemGroup exists in this World, it is appended to the Initialization player loop phase.
- If an instance of SimulationSystemGroup exists in this World, it is appended to the Update player loop phase.
- If an instance of PresentationSystemGroup exists in this World, it is appended to the PreLateUpdate player loop phase. If instances of any or all of these system groups don't exist in this World, then no entry is added to the player loop for that system group.


This function does not change the currently active player loop. If this behavior is desired, it's necessary to call PlayerLoop.SetPlayerLoop(playerLoop) after the systems have been removed.