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

Window that opens to edit a catch region in maps. More...

#include <CatchRegionWindow.hpp>

Public Types

using TriggerCb = std::function< void()>
 Called when the region is saved. More...
 

Public Member Functions

 CatchRegionWindow (const TriggerCb &onSave)
 Construct a new Catch Region Window. More...
 
void open (bl::gui::GUI *gui, const core::map::CatchRegion &region)
 Opens the window with the given region value. More...
 
const core::map::CatchRegiongetValue ()
 Returns the current region value as inputed by the user. More...
 

Detailed Description

Window that opens to edit a catch region in maps.

Definition at line 18 of file CatchRegionWindow.hpp.

Member Typedef Documentation

◆ TriggerCb

using editor::component::CatchRegionWindow::TriggerCb = std::function<void()>

Called when the region is saved.

Definition at line 21 of file CatchRegionWindow.hpp.

Constructor & Destructor Documentation

◆ CatchRegionWindow()

editor::component::CatchRegionWindow::CatchRegionWindow ( const TriggerCb onSave)

Construct a new Catch Region Window.

Parameters
onSaveCallback for when the region should be saved

Definition at line 25 of file CatchRegionWindow.cpp.

Member Function Documentation

◆ getValue()

const core::map::CatchRegion & editor::component::CatchRegionWindow::getValue ( )

Returns the current region value as inputed by the user.

Definition at line 82 of file CatchRegionWindow.cpp.

◆ open()

void editor::component::CatchRegionWindow::open ( bl::gui::GUI *  gui,
const core::map::CatchRegion region 
)

Opens the window with the given region value.

Parameters
guiThe main gui object
regionThe region to populate with

Definition at line 63 of file CatchRegionWindow.cpp.


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