Scripting/Squirrel/Functions/GetDistrictName: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will return the district name of a given position. == Syntax == <pre>GetDistrictName( x, y )</pre> == Arguments == * ''float'' '''x''' - The '''x''' coordina...")
 
(Added example.)
Line 15: Line 15:


== Example ==
== Example ==
 
<source lang="squirrel">
{{Scripting/Needs_Example}}
function onPlayerCommand( player, cmd, text )
{
if( cmd == "district" )
{
MessagePlayer("[#FFFFFF]Your district is [#FFFF00]"+GetDistrictName(player.Pos.x, player.Pos.y), player);
}
}
</source>


=== Notes ===
=== Notes ===

Revision as of 15:18, 1 August 2015

This function will return the district name of a given position.

Syntax

GetDistrictName( x, y )

Arguments

  • float x - The x coordinate
  • float y - The y coordinate

Return value

  • string name - The name of the district

Example

function onPlayerCommand( player, cmd, text )
{
	if( cmd == "district" )
	{
		MessagePlayer("[#FFFFFF]Your district is [#FFFF00]"+GetDistrictName(player.Pos.x, player.Pos.y), player);
	}
}

Notes

Related Functions