Scripting/Squirrel/Functions/GetDistrictName: Difference between revisions
Jump to navigation
Jump to search
This wiki is using an old backup from 2020
Some information may be old/missing
ProsuWANTED (talk | contribs) (Added example.) |
No edit summary |
||
Line 16: | Line 16: | ||
== Example == | == Example == | ||
<source lang="squirrel"> | <source lang="squirrel"> | ||
function onPlayerCommand( player, cmd, text ) | function onPlayerCommand(player, cmd, text) | ||
{ | { | ||
if( cmd == "district" ) | if(cmd == "district") | ||
{ | { | ||
MessagePlayer("[#FFFFFF]Your district is [#FFFF00]"+GetDistrictName(player.Pos.x, player.Pos.y), player); | MessagePlayer("[#FFFFFF]Your district is [#FFFF00]"+GetDistrictName(player.Pos.x, player.Pos.y), player); | ||
Line 26: | Line 26: | ||
=== 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}} |
Revision as of 16:47, 25 April 2016
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.