Scripting/Squirrel/Client Functions/GUI::GetMousePos

This function returns mouse position of the player.

Syntax

GUI.GetMousePos()

Return type

VectorScreen

Example

/* Player::PlayerDeath is triggered whenever someone die, we are going to use this for the sake of example */
function Player::PlayerDeath( player ) 
{
	/* Check whether the player that just died is local player/self by comparing ID */
	if ( player.ID == World.FindLocalPlayer( ).ID )
	{
		/* Get player's mouse position */
		local mousePos = GUI.GetMousePos( );

		if ( mousePos ) {
		    /* Send message to player about his mouse position */
			Console.Print( "Mouse position - X: "+ mousePos.X +", Y: "+ mousePos.Y );
		}
	}
}

Notes

Player::PlayerDeath, World::FindLocalPlayer and Console::Print were used in this example, more info about them in the corresponding pages.