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...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
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 ===
 
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Game_Functions}}
{{Scripting/Squirrel/Functions/Game_Functions}}
[[Category:Scripting/Squirrel/Functions/Game_Functions]]

Latest revision as of 18:06, 30 January 2017

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

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions