Cavestory Mod API
Public Member Functions | Public Attributes | List of all members
ModeInputOptionConfig Struct Reference

Advanced configuration for a ModeInputOption. More...

#include <ModeInputVector.h>

Public Member Functions

 ModeInputOptionConfig ()
 Default constructor.
 

Public Attributes

bool clickable
 Whether this option is clickable or not. More...
 
struct {
   int   left
 How much pressing 'left' while this option is selected will increment the selection position by.
 
   int   up
 How much pressing 'up' while this option is selected will increment the selection position by.
 
   int   right
 How much pressing 'right' while this option is selected will increment the selection position by.
 
   int   down
 How much pressing 'down' while this option is selected will increment the selection position by.
 
increment
 Increment options.
 
struct {
   bool   open_for_keyboard
 Whether or not to open the tooltip when the user selects it with the keyboard / controller.
 
   bool   allocate_text
 Whether or not to duplicate the string (true), or to just store a pointer to a buffer (false).
 
   GUI_POINT   surface_offset
 The screen offset of the surface that this option belongs to.
 
   int   magnification_lvl
 The amount of magnification for the tooltip. More...
 
   FontObject *   font
 The font to be used for this tooltip.
 
tooltip
 Tooltip options.
 

Detailed Description

Advanced configuration for a ModeInputOption.

Member Data Documentation

◆ clickable

bool ModeInputOptionConfig::clickable

Whether this option is clickable or not.

Useful for options that represent a tooltip area.

◆ magnification_lvl

int ModeInputOptionConfig::magnification_lvl

The amount of magnification for the tooltip.

If this equals '-1', then the current global magnification level is used.


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