Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Types | Public Member Functions | Public Attributes | List of all members
core::event::OpenPeoplemonMenu Struct Reference

Special event to trigger the opening of the peoplemon menu. More...

#include <PeoplemonMenu.hpp>

Public Types

enum class  Context {
  BattleSwitch , BattleFaint , BattleMustSwitch , BattleReviveSwitch ,
  StorageSelect , PauseMenu , GiveItem , UseItem ,
  UseItemBattle
}
 Represents where the menu is being opened from. More...
 

Public Member Functions

 OpenPeoplemonMenu (Context ctx, int outNow=-1, int *chosen=nullptr)
 Construct a new Open Peoplemon Menu event. More...
 

Public Attributes

const Context context
 
const int outNow
 
int * chosen
 

Detailed Description

Special event to trigger the opening of the peoplemon menu.

Definition at line 14 of file PeoplemonMenu.hpp.

Member Enumeration Documentation

◆ Context

Represents where the menu is being opened from.

Enumerator
BattleSwitch 
BattleFaint 
BattleMustSwitch 
BattleReviveSwitch 
StorageSelect 
PauseMenu 
GiveItem 
UseItem 
UseItemBattle 

Definition at line 19 of file PeoplemonMenu.hpp.

Constructor & Destructor Documentation

◆ OpenPeoplemonMenu()

core::event::OpenPeoplemonMenu::OpenPeoplemonMenu ( Context  ctx,
int  outNow = -1,
int *  chosen = nullptr 
)
inline

Construct a new Open Peoplemon Menu event.

Parameters
ctxThe context in which the menu is opened for
outNowIndex of the peoplemon out now
chosenTo store the index of the selected peoplemon

Definition at line 38 of file PeoplemonMenu.hpp.

Member Data Documentation

◆ chosen

int* core::event::OpenPeoplemonMenu::chosen

Definition at line 45 of file PeoplemonMenu.hpp.

◆ context

const Context core::event::OpenPeoplemonMenu::context

Definition at line 43 of file PeoplemonMenu.hpp.

◆ outNow

const int core::event::OpenPeoplemonMenu::outNow

Definition at line 44 of file PeoplemonMenu.hpp.


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