Human.: /* Example */

2018-10-02T14:27:53Z

Example

← Older revision		Revision as of 14:27, 2 October 2018
Line 20:		Line 20:

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

Human.: Created page with "This function returns mouse position of the player. == Syntax ==

GUI.GetMousePos()

== Return type == '''VectorScreen''' == Example == /*..."

2018-10-02T14:26:27Z

Created page with "This function returns mouse position of the player. == Syntax == <pre>GUI.GetMousePos()</pre> == Return type == '''VectorScreen''' == Example == <source lang=squirrel> /*..."

New page

This function returns mouse position of the player.

== Syntax ==
<pre>GUI.GetMousePos()</pre>

== Return type ==

'''VectorScreen'''

== Example ==
<source lang=squirrel>
/* 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 );
}
}
}
</source>

=== Notes ===
[[Scripting/Squirrel/Client_Events/Player::PlayerDeath|Player::PlayerDeath]], [[Scripting/Squirrel/Client_Functions/World::FindLocalPlayer|World::FindLocalPlayer]] and [[Scripting/Squirrel/Client_Functions/Console::Print|Console::Print]]
were used in this example, more info about them in the corresponding pages.

Scripting/Squirrel/Client Functions/GUI::GetMousePos - Revision history

Human.: /* Example */

Human.: Created page with "This function returns mouse position of the player. == Syntax ==
GUI.GetMousePos()
== Return type == '''VectorScreen''' == Example == /*..."