HatchitGame
Public Member Functions | Static Public Member Functions | Friends | List of all members
Hatchit::Game::Scene Class Reference

Defines a scene. More...

#include <ht_scene.h>

Inheritance diagram for Hatchit::Game::Scene:

Public Member Functions

 Scene (const Scene &rhs)=default
 
Sceneoperator= (const Scene &rhs)=default
 
 Scene (Scene &&rhs)
 
Sceneoperator= (Scene &&rhs)
 
std::string Name () const
 Gets this scene's name.
 
const Core::Guid & GUID () const
 Gets this scene's Guid. More...
 
bool LoadFromHandle (Resource::SceneHandle sceneHandle)
 Attempts to load the Scene using the provided handle. More...
 
void Render (void)
 Renders this scene.
 
void Update (void)
 Updates this scene.
 
void Unload (void)
 Unloads this scene and its game objects.
 

Static Public Member Functions

static GameObjectCreateGameObject ()
 Creates empty GameObject and adds it to the scene.
 
static GameObjectCreateGameObject (GameObject &prefab)
 Creates GameObject from prefab and adds it to the scene.
 

Friends

class SceneManager
 

Detailed Description

Defines a scene.

Member Function Documentation

const Guid & Hatchit::Game::Scene::GUID ( ) const

Gets this scene's Guid.

Returns
This scene's Guid.
bool Hatchit::Game::Scene::LoadFromHandle ( Resource::SceneHandle  sceneHandle)

Attempts to load the Scene using the provided handle.

Parameters
sceneHandleA handle a resource containing the JSON representing this Scene.
Returns
true if the Scene could be loaded successfully, false otherwise.
See also
SceneHandle(), SceneManager::LoadScene()

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