gemrb/GUIScripts/GUIDefines.py

   1 # -*-python-*-
   2 # GemRB - Infinity Engine Emulator
   3 # Copyright (C) 2003 The GemRB Project
   4 #
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18 #
  19
  20
  21 # GUIDefines.py - common definitions of GUI-related constants for GUIScripts
  22
  23 #button flags
  24 IE_GUI_BUTTON_NORMAL     = 0x00000004   #default button, doesn't stick
  25 IE_GUI_BUTTON_NO_IMAGE   = 0x00000001
  26 IE_GUI_BUTTON_PICTURE    = 0x00000002
  27 IE_GUI_BUTTON_SOUND      = 0x00000004
  28 IE_GUI_BUTTON_ALT_SOUND  = 0x00000008
  29 IE_GUI_BUTTON_CHECKBOX   = 0x00000010   #or radio button
  30 IE_GUI_BUTTON_RADIOBUTTON= 0x00000020   #sticks in a state
  31 IE_GUI_BUTTON_DEFAULT    = 0x00000040   #enter key triggers it
  32 IE_GUI_BUTTON_ANIMATED   = 0x00000080   # the button is animated
  33
  34 #these bits are hardcoded in the .chu structure, don't move them
  35 IE_GUI_BUTTON_ALIGN_LEFT = 0x00000100
  36 IE_GUI_BUTTON_ALIGN_RIGHT= 0x00000200
  37 IE_GUI_BUTTON_ALIGN_TOP  = 0x00000400
  38 IE_GUI_BUTTON_ALIGN_BOTTOM = 0x00000800
  39 IE_GUI_BUTTON_ALIGN_ANCHOR = 0x00001000
  40 IE_GUI_BUTTON_LOWERCASE    = 0x00002000
  41
  42 #end of hardcoded section
  43 IE_GUI_BUTTON_DRAGGABLE    = 0x00004000
  44 IE_GUI_BUTTON_MULTILINE    = 0x00008000 # don't set the SINGLE_LINE font rendering flag
  45 IE_GUI_BUTTON_NO_TEXT    = 0x00010000   # don't draw button label
  46 IE_GUI_BUTTON_PLAYRANDOM = 0x00020000   # the button animation is random
  47 IE_GUI_BUTTON_PLAYONCE   = 0x00040000   # the button animation won't restart
  48
  49 IE_GUI_BUTTON_CENTER_PICTURES = 0x00080000 # center the button's PictureList
  50 IE_GUI_BUTTON_BG1_PAPERDOLL   = 0x00100000 # BG1-style paperdoll
  51 IE_GUI_BUTTON_HORIZONTAL      = 0x00200000 # horizontal clipping of overlay
  52 IE_GUI_BUTTON_CANCEL          = 0x00400000 # escape key triggers it
  53 IE_GUI_BUTTON_CAPS            = 0x00800000 # capitalize all the text (default for bg2)
  54
  55 #scrollbar flags
  56 IE_GUI_SCROLLBAR_DEFAULT = 0x00000040   # mousewheel triggers it (same value as default button)
  57
  58 #textarea flags
  59 IE_GUI_TEXTAREA_SELECTABLE = 0x05000001
  60 IE_GUI_TEXTAREA_AUTOSCROLL = 0x05000002
  61 IE_GUI_TEXTAREA_SMOOTHSCROLL = 0x05000004
  62 IE_GUI_TEXTAREA_HISTORY = 0x05000008
  63 IE_GUI_TEXTAREA_SPEAKER = 0x05000010
  64 IE_GUI_TEXTAREA_EDITABLE = 0x05000040
  65
  66 #gui control types
  67 IE_GUI_BUTTON = 0
  68 IE_GUI_PROGRESS = 1
  69 IE_GUI_SLIDER = 2
  70 IE_GUI_EDIT = 3
  71 IE_GUI_TEXTAREA = 5
  72 IE_GUI_LABEL = 6
  73 IE_GUI_SCROLLBAR = 7
  74 IE_GUI_WORLDMAP = 8
  75 IE_GUI_MAP = 9
  76
  77 #events
  78 IE_GUI_BUTTON_ON_PRESS      = 0x00000000
  79 IE_GUI_MOUSE_OVER_BUTTON    = 0x00000001
  80 IE_GUI_MOUSE_ENTER_BUTTON   = 0x00000002
  81 IE_GUI_MOUSE_LEAVE_BUTTON   = 0x00000003
  82 IE_GUI_BUTTON_ON_SHIFT_PRESS= 0x00000004
  83 IE_GUI_BUTTON_ON_RIGHT_PRESS= 0x00000005
  84 IE_GUI_BUTTON_ON_DRAG_DROP  = 0x00000006
  85 IE_GUI_BUTTON_ON_DRAG_DROP_PORTRAIT = 0x00000007
  86 IE_GUI_BUTTON_ON_DRAG       = 0x00000008
  87 IE_GUI_BUTTON_ON_DOUBLE_PRESS = 0x00000009
  88 IE_GUI_PROGRESS_END_REACHED = 0x01000000
  89 IE_GUI_SLIDER_ON_CHANGE     = 0x02000000
  90 IE_GUI_EDIT_ON_CHANGE       = 0x03000000
  91 IE_GUI_EDIT_ON_DONE         = 0x03000001
  92 IE_GUI_EDIT_ON_CANCEL       = 0x03000002
  93 IE_GUI_TEXTAREA_ON_CHANGE   = 0x05000000
  94 IE_GUI_TEXTAREA_OUT_OF_TEXT = 0x05000001
  95 IE_GUI_LABEL_ON_PRESS       = 0x06000000
  96 IE_GUI_SCROLLBAR_ON_CHANGE  = 0x07000000
  97 IE_GUI_WORLDMAP_ON_PRESS    = 0x08000000
  98 IE_GUI_MOUSE_ENTER_WORLDMAP = 0x08000002
  99 IE_GUI_MAP_ON_PRESS         = 0x09000000
 100 IE_GUI_MAP_ON_RIGHT_PRESS   = 0x09000005
 101 IE_GUI_MAP_ON_DOUBLE_PRESS  = 0x09000008
 102
 103 #common states
 104 IE_GUI_CONTROL_FOCUSED    = 0x7f000080
 105
 106 #button states
 107 IE_GUI_BUTTON_ENABLED    = 0x00000000
 108 IE_GUI_BUTTON_UNPRESSED  = 0x00000000
 109 IE_GUI_BUTTON_PRESSED    = 0x00000001
 110 IE_GUI_BUTTON_SELECTED   = 0x00000002
 111 IE_GUI_BUTTON_DISABLED   = 0x00000003
 112 # Like DISABLED, but processes MouseOver events and draws UNPRESSED bitmap
 113 IE_GUI_BUTTON_LOCKED   = 0x00000004
 114 # Draws DISABLED bitmap, but it isn't disabled
 115 IE_GUI_BUTTON_THIRD    = 0x00000005
 116 # Draws PRESSED bitmap, but it isn't shifted
 117 IE_GUI_BUTTON_SECOND   = 0x00000006
 118
 119 #edit field states
 120 IE_GUI_EDIT_NUMBER    =  0x030000001
 121
 122 #mapcontrol states (add 0x090000000 if used with SetControlStatus)
 123 IE_GUI_MAP_NO_NOTES   =  0
 124 IE_GUI_MAP_VIEW_NOTES =  1
 125 IE_GUI_MAP_SET_NOTE   =  2
 126 IE_GUI_MAP_REVEAL_MAP =  3
 127
 128 # !!! Keep these synchronized with WorldMapControl.h !!!
 129 # WorldMap label colors
 130 IE_GUI_WMAP_COLOR_NORMAL     = 0
 131 IE_GUI_WMAP_COLOR_SELECTED   = 1
 132 IE_GUI_WMAP_COLOR_NOTVISITED = 2
 133
 134 # !!! Keep these synchronized with Font.h !!!
 135 IE_FONT_ALIGN_LEFT       = 0x00
 136 IE_FONT_ALIGN_CENTER     = 0x01
 137 IE_FONT_ALIGN_RIGHT      = 0x02
 138 IE_FONT_ALIGN_BOTTOM     = 0x04
 139 IE_FONT_ALIGN_TOP        = 0x10   # Single-Line and Multi-Line Text
 140 IE_FONT_ALIGN_MIDDLE     = 0x20   #Only for single line Text
 141 IE_FONT_SINGLE_LINE      = 0x40
 142
 143 OP_SET = 0
 144 OP_AND = 1
 145 OP_OR = 2
 146 OP_XOR = 3
 147 OP_NAND = 4
 148
 149 # Window position anchors/alignments
 150 # !!! Keep these synchronized with Window.h !!!
 151 WINDOW_TOPLEFT       = 0x00
 152 WINDOW_CENTER        = 0x01
 153 WINDOW_ABSCENTER     = 0x02
 154 WINDOW_RELATIVE      = 0x04
 155 WINDOW_SCALE         = 0x08
 156 WINDOW_BOUNDED       = 0x10
 157
 158 # GameScreen flags
 159 GS_PARTYAI           = 1
 160 GS_SMALLDIALOG       = 0
 161 GS_MEDIUMDIALOG      = 2
 162 GS_LARGEDIALOG       = 6
 163 GS_DIALOGMASK        = 6
 164 GS_DIALOG            = 8
 165 GS_HIDEGUI           = 16
 166 GS_OPTIONPANE        = 32
 167 GS_PORTRAITPANE      = 64
 168 GS_MAPNOTE           = 128
 169
 170 # GameControl screen flags
 171 # !!! Keep these synchronized with GameControl.h !!!
 172 SF_DISABLEMOUSE      = 1
 173 SF_CENTERONACTOR     = 2
 174 SF_ALWAYSCENTER      = 4
 175 SF_GUIENABLED        = 8
 176 SF_LOCKSCROLL        = 16
 177
 178 # GameControltarget modes
 179 # !!! Keep these synchronized with GameControl.h !!!
 180 TARGET_MODE_NONE    = 0
 181 TARGET_MODE_TALK    = 1
 182 TARGET_MODE_ATTACK  = 2
 183 TARGET_MODE_CAST    = 3
 184 TARGET_MODE_DEFEND  = 4
 185 TARGET_MODE_PICK    = 5
 186
 187 GA_SELECT     = 16
 188 GA_NO_DEAD    = 32
 189 GA_POINT      = 64
 190 GA_NO_HIDDEN  = 128
 191 GA_NO_ALLY    = 256
 192 GA_NO_ENEMY   = 512
 193 GA_NO_NEUTRAL = 1024
 194 GA_NO_SELF    = 2048
 195
 196 # Shadow color for ShowModal()
 197 # !!! Keep these synchronized with Interface.h !!!
 198 MODAL_SHADOW_NONE = 0
 199 MODAL_SHADOW_GRAY = 1
 200 MODAL_SHADOW_BLACK = 2
 201
 202 # Flags for SetVisible()
 203 # !!! Keep these synchronized with Interface.h !!!
 204 #WINDOW_INVALID = -1
 205 WINDOW_INVISIBLE = 0
 206 WINDOW_VISIBLE = 1
 207 WINDOW_GRAYED = 2
 208 WINDOW_FRONT = 3
 209
 210 # Flags for GameSelectPC()
 211 # !!! Keep these synchronized with Game.h !!!
 212 SELECT_NORMAL  = 0x00
 213 SELECT_REPLACE = 0x01
 214 SELECT_QUIET   = 0x02
 215
 216 # Spell types
 217 # !!! Keep these synchronized with Spellbook.h !!!
 218 IE_SPELL_TYPE_PRIEST = 0
 219 IE_SPELL_TYPE_WIZARD = 1
 220 IE_SPELL_TYPE_INNATE = 2
 221
 222 # Item Flags bits
 223 # !!! Keep these synchronized with Item.h !!!
 224 IE_ITEM_CRITICAL     = 0x00000001
 225 IE_ITEM_TWO_HANDED   = 0x00000002
 226 IE_ITEM_MOVABLE      = 0x00000004
 227 IE_ITEM_DISPLAYABLE  = 0x00000008
 228 IE_ITEM_CURSED       = 0x00000010
 229 IE_ITEM_NOT_COPYABLE = 0x00000020
 230 IE_ITEM_MAGICAL      = 0x00000040
 231 IE_ITEM_BOW          = 0x00000080
 232 IE_ITEM_SILVER       = 0x00000100
 233 IE_ITEM_COLD_IRON    = 0x00000200
 234 IE_ITEM_STOLEN       = 0x00000400
 235 IE_ITEM_CONVERSABLE  = 0x00000800
 236 IE_ITEM_PULSATING    = 0x00001000
 237 IE_ITEM_UNSELLABLE   = (IE_ITEM_CRITICAL | IE_ITEM_STOLEN)
 238
 239 # CREItem (SlotItem) Flags bits
 240 # !!! Keep these synchronized with Inventory.h !!!
 241 IE_INV_ITEM_IDENTIFIED    = 0x01
 242 IE_INV_ITEM_UNSTEALABLE   = 0x02
 243 IE_INV_ITEM_STOLEN        = 0x04
 244 IE_INV_ITEM_UNDROPPABLE   = 0x08
 245 # GemRB extensions
 246 IE_INV_ITEM_ACQUIRED      = 0x10
 247 IE_INV_ITEM_DESTRUCTIBLE  = 0x20
 248 IE_INV_ITEM_EQUIPPED      = 0x40
 249 IE_INV_ITEM_STACKED       = 0x80
 250 # these come from the original item bits
 251 IE_INV_ITEM_CRITICAL      = 0x100
 252 IE_INV_ITEM_TWOHANDED     = 0x200
 253 IE_INV_ITEM_MOVABLE       = 0x400
 254 IE_INV_ITEM_UNKNOWN800    = 0x800
 255 IE_INV_ITEM_CURSED        = 0x1000
 256 IE_INV_ITEM_UNKNOWN2000   = 0x2000
 257 IE_INV_ITEM_MAGICAL       = 0x4000
 258 IE_INV_ITEM_BOW           = 0x8000
 259 IE_INV_ITEM_SILVER        = 0x10000
 260 IE_INV_ITEM_COLDIRON      = 0x20000
 261 IE_INV_ITEM_STOLEN2       = 0x40000
 262 IE_INV_ITEM_CONVERSIBLE   = 0x80000
 263 IE_INV_ITEM_PULSATING     = 0x100000
 264
 265 #repeat key flags
 266 GEM_RK_DOUBLESPEED = 1
 267 GEM_RK_DISABLE = 2
 268 GEM_RK_QUADRUPLESPEED = 4
 269
 270 SHOP_BUY    = 1
 271 SHOP_SELL   = 2
 272 SHOP_ID     = 4
 273 SHOP_STEAL  = 8
 274 SHOP_SELECT = 0x40
 275
 276 #game constants
 277 PARTY_SIZE = 6
 278
 279 # !!! Keep this synchronized with Video.h !!!
 280 TOOLTIP_DELAY_FACTOR = 250
 281
 282 #game strings
 283 STR_LOADMOS  = 0
 284 STR_AREANAME = 1
 285
 286 #game integers
 287 SV_BPP = 0
 288 SV_WIDTH = 1
 289 SV_HEIGHT = 2
 290 global GEMRB_VERSION
 291 GEMRB_VERSION = -1