This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Environment System

Runtime system component that drives the world clock tick and handles GS_EnvironmentRequestBus queries.

The Environment System Component is the gem-level runtime system for GS_Environment. It extends AZ::Component and implements AZ::TickBus::Handler to advance the world clock each frame. It handles GS_EnvironmentRequestBus queries and coordinates global environment state across the level.

This component activates automatically as part of the GS_Environment gem – it does not need to be added manually to any entity.

For usage guides and setup examples, see The Basics: GS_Environment.

Sky Colour Configuration asset in the O3DE Asset Editor

 

Contents


How It Works

Tick Integration

The Environment System Component connects to AZ::TickBus on activation. Each tick it drives the Time Manager’s clock advancement and ensures all environment-dependent systems receive their frame update in the correct order.

Environment Requests

GS_EnvironmentRequestBus provides a global access point for querying environment state. The system component is the sole handler; any gem or component can broadcast requests to read current environment conditions.


API Reference

GS_EnvironmentSystemComponent

FieldValue
TypeId{57B91AE7-B0EC-467E-A359-150B5FB993F9}
ExtendsAZ::Component, AZ::TickBus::Handler
HeaderGS_Environment/GS_EnvironmentBus.h

Request Bus: GS_EnvironmentRequestBus

Commands sent to the Environment System. Singleton bus – Single address, single handler.

FieldValue
Interface TypeId{39599FDC-B6DC-4143-A474-9B525599C919}
MethodParametersReturnsDescription
(base interface)Extended by project-level environment systems as needed.

See Also

For conceptual overviews and usage guides:

For component references:

  • Time Manager – World clock, day/night cycle, and per-tick notifications

Get GS_Environment

GS_Environment — Explore this gem on the product page and add it to your project.