Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Types | Public Member Functions | List of all members
editor::component::RenderMapWindow Class Reference

Options window to help trigger map renderings. More...

#include <RenderMapWindow.hpp>

Public Types

using StartRender = std::function< void()>
 Callback for when the render should trigger. More...
 

Public Member Functions

 RenderMapWindow (const StartRender &onStart)
 Construct a new Render Map Window. More...
 
void open (bl::gui::GUI *gui)
 Opens the window. More...
 
const std::string & outputPath () const
 Returns the filename to output to. More...
 
bool renderCharacters () const
 Returns whether or not to render the characters in the map. More...
 
std::uint8_t lightLevel () const
 Returns the light level to render the map at. More...
 

Detailed Description

Options window to help trigger map renderings.

Definition at line 18 of file RenderMapWindow.hpp.

Member Typedef Documentation

◆ StartRender

using editor::component::RenderMapWindow::StartRender = std::function<void()>

Callback for when the render should trigger.

Definition at line 21 of file RenderMapWindow.hpp.

Constructor & Destructor Documentation

◆ RenderMapWindow()

editor::component::RenderMapWindow::RenderMapWindow ( const StartRender onStart)

Construct a new Render Map Window.

Parameters
onStartCallback to call when a rendering should take place

Definition at line 9 of file RenderMapWindow.cpp.

Member Function Documentation

◆ lightLevel()

std::uint8_t editor::component::RenderMapWindow::lightLevel ( ) const

Returns the light level to render the map at.

Definition at line 42 of file RenderMapWindow.cpp.

◆ open()

void editor::component::RenderMapWindow::open ( bl::gui::GUI *  gui)

Opens the window.

Parameters
guiThe parent GUI object

Definition at line 32 of file RenderMapWindow.cpp.

◆ outputPath()

const std::string & editor::component::RenderMapWindow::outputPath ( ) const

Returns the filename to output to.

Definition at line 38 of file RenderMapWindow.cpp.

◆ renderCharacters()

bool editor::component::RenderMapWindow::renderCharacters ( ) const

Returns whether or not to render the characters in the map.

Definition at line 40 of file RenderMapWindow.cpp.


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