Cavestory Mod API
Public Types | Public Attributes | List of all members
ModeInputOption Struct Reference

ModeInputVector's input object. More...

#include <ModeInputVector.h>

Public Types

enum  OptionFlags {
  AUTO_EXPAND_WIDTH = BIT(0) , AUTO_EXPAND_HEIGHT = BIT(1) , START_FROM_RIGHT = BIT(2) , START_FROM_BOTTOM = BIT(3) ,
  START_ON_NEW_LINE = BIT(4) , AUTOMATION_FLAGS = AUTO_EXPAND_WIDTH | AUTO_EXPAND_HEIGHT
}
 Flags for ModeInputVector options. More...
 

Public Attributes

ModeInputIndex index
 The local index of this option.
 
unsigned int flags
 Flags for this option.
 
ModeInputSelectionId selection_id
 The ID that will be returned when this option is selected / clicked on.
 
struct {
   bool   use
 Whether this option can be built into the array or not. More...
 
   ModeInputOptionCoord   x
 X Position.
 
   ModeInputOptionCoord   y
 Y Position.
 
   ModeInputOptionCoord   w
 Width.
 
   ModeInputOptionCoord   h
 Height.
 
input_rect
 The input vector position of this option.
 
struct {
   ModeInputOptionCoord   x
 X Position.
 
   ModeInputOptionCoord   y
 Y Position.
 
   ModeInputOptionCoord   w
 Width.
 
   ModeInputOptionCoord   h
 Height.
 
calculated_input_rect
 The calculated input vector rect for this option.
 
struct {
   bool   use
 Whether to use this clip rect or not.
 
   GUI_RECT   rect
 The rect to use.
 
clip
 The clip rect that should be accessed before this option can be processed.
 
struct {
   bool   enabled
 Whether this tooltip is enabled or not.
 
   char *   text
 The tooltip text to use.
 
tooltip
 The tooltip for this option.
 
ModeInputOptionConfig config
 The configuration for this option.
 
ScrollAreaInfoscroll_ptr
 A pointer to the scroll this option is inside of.
 
GUI_RECTrect_ptr
 A pointer to this input option's on-screen rect.
 
GuiBasegui_ptr
 This option's GUI element. More...
 
GUI_RECT rect_plain
 This option's rect. More...
 

Detailed Description

ModeInputVector's input object.

Member Enumeration Documentation

◆ OptionFlags

Flags for ModeInputVector options.

Enumerator
AUTO_EXPAND_WIDTH 

Auto expand the option's array width to the fullest possible extent.

AUTO_EXPAND_HEIGHT 

Auto expand the option's array height to the fullest possible extent.

START_FROM_RIGHT 

Subtract this option's input_rect.x value from the array width to get the option's true X position.

START_FROM_BOTTOM 

Subtract this option's input_rect.y value from the array height to get the option's true Y position.

START_ON_NEW_LINE 

Start this option on a new line.

AUTOMATION_FLAGS 

Automation flags.

Member Data Documentation

◆ gui_ptr

GuiBase* ModeInputOption::gui_ptr

This option's GUI element.

Can be NULL.

◆ rect_plain

GUI_RECT ModeInputOption::rect_plain

This option's rect.

Only use this if both rect_ptr and gui_ptr are NULL.

◆ use

bool ModeInputOption::use

Whether this option can be built into the array or not.

Whether to use this clip rect or not.

If set to false, then this option cannot be reached using a controller / the keyboard.


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