Unravel Engine C++ Reference
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
unravel::play_mode Struct Reference

Owns play-mode state and orchestrates the splash -> running lifecycle. More...

#include <play_mode.h>

Public Types

enum class  phase { inactive , splash , running }
 

Public Member Functions

auto init (rtti::context &ctx) -> bool
 
auto deinit (rtti::context &ctx) -> bool
 
void toggle (rtti::context &ctx, bool allow_splash=true)
 
void set_active (rtti::context &ctx, bool active, bool allow_splash=true)
 
void set_paused (rtti::context &ctx, bool paused)
 
void toggle_pause (rtti::context &ctx)
 
void skip_next_frame (rtti::context &ctx)
 
void on_frame_update (rtti::context &ctx, delta_t dt)
 
auto is_active () const -> bool
 
auto is_simulation_running () const -> bool
 
auto is_splash () const -> bool
 
auto is_paused () const -> bool
 
auto frames_running () const -> uint64_t
 
void on_simulation_frame ()
 
auto current_phase () const -> phase
 

Detailed Description

Owns play-mode state and orchestrates the splash -> running lifecycle.

Definition at line 16 of file play_mode.h.

Member Enumeration Documentation

◆ phase

enum class unravel::play_mode::phase
strong
Enumerator
inactive 
splash 
running 

Definition at line 18 of file play_mode.h.

Member Function Documentation

◆ current_phase()

auto unravel::play_mode::current_phase ( ) const -> phase
inlinenodiscard

Definition at line 63 of file play_mode.h.

◆ deinit()

auto unravel::play_mode::deinit ( rtti::context & ctx) -> bool

Definition at line 23 of file play_mode.cpp.

◆ frames_running()

auto unravel::play_mode::frames_running ( ) const -> uint64_t
inlinenodiscard

Definition at line 56 of file play_mode.h.

◆ init()

auto unravel::play_mode::init ( rtti::context & ctx) -> bool

Definition at line 15 of file play_mode.cpp.

◆ is_active()

auto unravel::play_mode::is_active ( ) const -> bool
inlinenodiscard

Definition at line 36 of file play_mode.h.

◆ is_paused()

auto unravel::play_mode::is_paused ( ) const -> bool
inlinenodiscard

Definition at line 51 of file play_mode.h.

◆ is_simulation_running()

auto unravel::play_mode::is_simulation_running ( ) const -> bool
inlinenodiscard

Definition at line 41 of file play_mode.h.

◆ is_splash()

auto unravel::play_mode::is_splash ( ) const -> bool
inlinenodiscard

Definition at line 46 of file play_mode.h.

◆ on_frame_update()

void unravel::play_mode::on_frame_update ( rtti::context & ctx,
delta_t dt )

Definition at line 97 of file play_mode.cpp.

◆ on_simulation_frame()

void unravel::play_mode::on_simulation_frame ( )

Definition at line 169 of file play_mode.cpp.

◆ set_active()

void unravel::play_mode::set_active ( rtti::context & ctx,
bool active,
bool allow_splash = true )

Definition at line 43 of file play_mode.cpp.

◆ set_paused()

void unravel::play_mode::set_paused ( rtti::context & ctx,
bool paused )

Definition at line 59 of file play_mode.cpp.

◆ skip_next_frame()

void unravel::play_mode::skip_next_frame ( rtti::context & ctx)

Definition at line 84 of file play_mode.cpp.

◆ toggle()

void unravel::play_mode::toggle ( rtti::context & ctx,
bool allow_splash = true )

Definition at line 33 of file play_mode.cpp.

◆ toggle_pause()

void unravel::play_mode::toggle_pause ( rtti::context & ctx)

Definition at line 74 of file play_mode.cpp.

The documentation for this struct was generated from the following files: