Advanced Strategic Command
Public Member Functions | List of all members
MainScreenWidget::StandardActionLocker Class Reference

Instanciating this class will disable the Controls for interacting with the map or the main menu. More...

#include <mainscreenwidget.h>

Public Member Functions

 StandardActionLocker (MainScreenWidget *mainScreenWidget, int options)
 Disables certain controls on the game's screen. More...
 
 StandardActionLocker (const StandardActionLocker &locker)
 
void lock ()
 
void unlock ()
 
 ~StandardActionLocker ()
 

Detailed Description

Instanciating this class will disable the Controls for interacting with the map or the main menu.

Example use is for running the AI, during the player shouldn't be able to do anything on his own. Instances are typically placed as local variable on the stack and will release automatically when the function is left

Definition at line 71 of file mainscreenwidget.h.

Constructor & Destructor Documentation

MainScreenWidget::StandardActionLocker::StandardActionLocker ( MainScreenWidget mainScreenWidget,
int  options 
)

Disables certain controls on the game's screen.

Parameters
mainScreenWidgetthe widget of the main screen (there is typically only one
See Also
getMainScreenWidget()
Parameters
thesum of all control items that are to be disabled.
See Also
MainScreenWidget::LockOptions

Definition at line 40 of file mainscreenwidget.cpp.

References lock().

MainScreenWidget::StandardActionLocker::StandardActionLocker ( const StandardActionLocker locker)

Definition at line 46 of file mainscreenwidget.cpp.

References lock().

MainScreenWidget::StandardActionLocker::~StandardActionLocker ( )

Definition at line 75 of file mainscreenwidget.cpp.

Member Function Documentation

void MainScreenWidget::StandardActionLocker::lock ( )

Definition at line 55 of file mainscreenwidget.cpp.

Referenced by StandardActionLocker().

void MainScreenWidget::StandardActionLocker::unlock ( )

Definition at line 64 of file mainscreenwidget.cpp.


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