Method AddWorldToPlayerLoop

AddWorldToPlayerLoop(World, ref PlayerLoopSystem)

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

Declaration

public static void AddWorldToPlayerLoop(World world, ref PlayerLoopSystem playerLoop)

Parameters

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

Remarks

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.