MouseAPI

[MindWorX]

MouseAPI allows getting and setting mouse coordinates. These aren't relative to the game, but just the screen coordinates.

native GetMouseX            takes nothing                   returns integer
native GetMouseY            takes nothing                   returns integer
native GetMouseXRelative    takes nothing                   returns integer
native GetMouseYRelative    takes nothing                   returns integer
native SetMouseX            takes integer x                 returns nothing
native SetMouseY            takes integer y                 returns nothing
native SetMousePos          takes integer x, integer y      returns nothing
//
//===================================================
// Mouse API constants
//===================================================
constant integer EVENT_LMOUSEUP 	= 0
constant integer EVENT_LMOUSEDOWN 	= 1
constant integer EVENT_RMOUSEUP 	= 2
constant integer EVENT_RMOUSEDOWN 	= 3
constant integer EVENT_MMOUSEUP 	= 4
constant integer EVENT_MMOUSEDOWN 	= 5
constant integer EVENT_MOUSEWHEEL 	= 6
// New Functions
native TriggerRegisterMouseEvent takes trigger whichTrigger, integer eventtype returns nothing
native GetTriggerWheelDelta takes nothing                   returns integer

Download: N/A Part of official Release
Native Set Type: Single Player or WarSoc
Release: 0.02alpha, updated in 0.10

GetMouseX Gets the X component of the mouse position.
GetMouseY Gets the Y component of the mouse position.
GetMouseXRelative Gets the X component of the mouse position relative to the window.
GetMouseYRelative Gets the Y component of the mouse position relative to the window.
SetMouseX Sets the X component of the mouse position.
SetMouseY Sets the Y component of the mouse position.
SetMousePos Sets the X and Y component of the mouse position, faster if you need to move both at once.

Example usage:

 local integer mx = GetMouseX()
 local integer my = GetMouseY()
 local integer vx = GetWindowWidth()/2 //GetWindowWidth is part of WindowAPI
 local integer vy = GetWindowHeight()/2 //GetWindowHeight is part of WindowAPI

    set vx = vx-mx
    set vy = vy-my
        //now you can use vx and vy as offset variables to move things. Like a unit.
    call SetMouseX(GetWindowWidth()/2) //GetWindowWidth is part of WindowAPI
    call SetMouseY(GetWindowHeight()/2) //GetWindowHeight is part of WindowAPI

 

[PurplePoot]

(bump) Does GetMouseX/YRelative relate to the game, then?

 

[MindWorX]

(bump) Does GetMouseX/YRelative relate to the game, then?

It's relative to the window x and y, incase someone, like me, sometimes test or play in windowed mode.

 

[MindWorX]

Bump, new update.

 

[wd40bomber7]

How fast are these? Will it badly affect my performance to run the example script every .04 seconds? (Or faster?)

 

[MindWorX]

I've made a map where it ran 0.01 for a smooth movement control of a flying glaive. So I'm pretty sure it's fast enough.

 

[wd40bomber7]

Great, thats all I need to know about MouseAPI.
I'm using it in a first person shooter. The only problem is I can't get the screen to rotate correctly. The custom natives work fine, I'm just not sure how to go about rotating the camera.
If you have any time, check the below post to see what I've tried.
http://www.hiveworkshop.com/forums/showthread.php?t=51428

 

[MindWorX]

I see that you found a solution to the problem you had. Be sure to write once you have a demo of the FPS engine you're doing, would be a great demo to show the possibilities of the MouseAPI.

 

[Bubba Ex]

how do I get the mouse x and y for each individual player? Using GetLocalPlayer()?

EDIT:
Didn't read the 'single player or WarSoc' part, sorry.

 

[SFilip]

Well, it will in theory work in multiplayer (under the condition all players have rtc), but syncing might be hard to accomplish.

 

[Need_O2]

I think its impossible to play the maps made with it in Bnet
because its impossible to change mause position in default Wc3
so all players will have to have RtC
Wc3 doesnt sync the mause because it would delay AFAIK

 

[Dynasti]

It should be returns real not integer

 

[SFilip]

Which one? And why?

 

[MeKC]

Is it possible that you can get the mouse position of the map? That would be usefull for fullscreen system.

 

[MindWorX]

We have that implemented in the newest unreleased version. Be patient, it's right on the doorsteps.

 

[Silvenon]

This is really great, but why does the are the returned coordinates integers?

 

[HappyTauren]

Because coordinates on the screen ARE integers, you can't have 1024.2x768.4 resolution, get what I mean? You can't divide a pixel, and number of pixels is an integer.

 

[Silvenon]

Oh... It doesn't return the map coordinates? So what can you use that API for then? Because then you don't know where that point is on the map.

 

[HappyTauren]

You calculate it?

 

[busterkomo]

Oh... It doesn't return the map coordinates? So what can you use that API for then? Because then you don't know where that point is on the map.

Use GetMouseTargetX() and GetMouseTargetY().

 

[Silvenon]

Use GetMouseTargetX() and GetMouseTargetY().

Thanks

I suppose this thread is a bit outdated, MindWorX should note that we should visit the thread on wc3c (link)