Scripting/Squirrel/Functions/GetWorldBounds: 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 get the world bounds of the server. == Syntax == <pre>GetWorldBounds( maxX, minX, maxY, minY )</pre> == Arguments == '''N/A''' == Return value == * ''...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Syntax ==
== Syntax ==


<pre>GetWorldBounds( maxX, minX, maxY, minY )</pre>
<pre>GetWorldBounds()</pre>
 
== Arguments ==
 
'''N/A'''


== Return value ==
== Return value ==
 
*[[Scripting/Squirrel/Functions/Bounds|''Bounds'']] '''worldbounds''' - the bounds
* ''float'' '''maxX''' - The X max
* ''float'' '''minX''' - The X min
* ''float'' '''maxY''' - The Y max
* ''float'' '''minY''' - The Y min


== Example ==
== Example ==
 
<source lang="squirrel">
{{Scripting/Needs_Example}}
function onScriptLoad()
{
local boundaries = GetWorldBounds();
print( "Worldboundaries has been set to :" + boundaries.MaxX + "," + boundaries.MinX + "," + boundaries.MaxY + "," + boundaries.MinY );
return 1;
}
</source>


=== Notes ===
=== Notes ===
 
Call [[OnScriptLoad]] 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:05, 30 January 2017

This function will get the world bounds of the server.

Syntax

GetWorldBounds()

Return value

  • Bounds worldbounds - the bounds

Example

function onScriptLoad()
{
	local boundaries = GetWorldBounds();
	print( "Worldboundaries has been set to :" + boundaries.MaxX + "," + boundaries.MinX + "," + boundaries.MaxY + "," + boundaries.MinY );
	return 1;
}

Notes

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

Related Functions