MouseEventType (Civ5 Type)
This page is a part of the Lua and UI Reference (Civ5).
|
The MouseEventType pseudo-type is actually a regular integer. Pseudo-types do not exist in Lua, they only serve a documentation purpose on the wiki!
|
Integers labeled as
Lua: the MouseEvents enumeration
Firaxis provides a Lua enumeration named MouseEvents. 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
"MouseMove"
512
"MouseFirst"
512
"LButtonDown"
513
"LButtonUp"
514
"LButtonDoubleClick"
515
"RButtonDown"
516
"RButtonUp"
517
"RButtonDoubleClick"
518
"MButtonDown"
519
"MButtonUp"
520
"MButtonDoubleClick"
521
"MouseWheel"
522
"XButtonDown"
523
"XButtonUp"
524
"MouseLast"
525
"XButtonDoubleClick"
525
Examples
Here is how to use the LUA enumeration to retrieve the ID from the type. Those examples will return and assign the integer value 512.
local id = MouseEvents.MouseMove
local id = MouseEvents["MouseMove"]
Used by
|
Context:SetInputHandler((void func(MouseEventType uiMsg, KeyType wParam, unknown lParam)) InputHandler)
|
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.
