MouseType (Civ5 Type)

From Civilization Modding Wiki
Revision as of 14:50, 19 September 2012 by DonQuich (talk | contribs) (Bot update)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page is a part of the Lua and UI Reference (Civ5).

ID.png The MouseType pseudo-type is actually a regular integer. Pseudo-types do not exist in Lua, they only serve a documentation purpose on the wiki!
  • Lua.png Integers labeled as MouseType corresponds to the constants defined in the Mouse Lua enumeration.

Lua: the Mouse enumeration

Firaxis provides a Lua enumeration named Mouse. This is just a regular global table. Its keys are the constants' names and the pairs the corresponding values.

Below are the values found in this enumeration.

Key Value
"eLClick" 0
"eRClick" 1
"eMClick" 2
"eWheel" 3
"eMouseEnter" 4
"eMouseExit" 5


Here is how to use the LUA enumeration to retrieve the ID from the type. Those examples will return and assign the integer value 0.

local id = Mouse.eLClick
local id = Mouse["eLClick"]

Used by

BoxButton:RegisterCallback(MouseType arg0, (void func()) MPListEntryClick)
Button:RegisterCallback(MouseType lClick, (void func(HandicapType index, ResourceType y, Button button, int x, int y)) OnEndTurnTimerClicked)
ButtonBase:ClearCallback(MouseType arg0)
CheckBox:RegisterCallback(MouseType arg0, (void func(SpecialistType Inc)) ModUnitFort)
Grid:RegisterCallback(MouseType thisEvent, (void func(PlayerID void1, ResourceType void2, Button button)) OnContinueButtonClicked)
GridButton:RegisterCallback(MouseType arg0, (void func(PolicyType Id, ResourceType none, Button control)) OnEndTurnClicked)
Image:RegisterCallback(MouseType arg0, (void func(EndTurnBlockingType Id)) OnEditNameClick)
LuaEvents.AdvisorButtonEvent(MouseType button)
RadioButton:RegisterCallback(MouseType arg0, (void func(SpecialistType void1, int Control)) ModeClicked)
Stack:RegisterCallback(MouseType arg0, (void func(EndTurnBlockingType Id)) GenericLeftClick)
TextButton:RegisterCallback(MouseType arg0, (void func(SpecialistType ePlayer)) OnCancelEditPlayerDetails)
TextButton:RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.