The Universal World Owner's Manual

This group collects a few different sets of functions relating to the world -

1. Functions for converting co-ordinates from map ('tile') to world scale
2. Functions for finding out how much of a particular object can be found in specified locations
3. Functions for controlling proximity ranges, where events are triggered when a player enters a particular region of the world

Example:

Event( "UseItem", "TileTeleport" )
{
    $tileCenterX = sysGetTileCenter( $gPlayerWorldX )
    $tileCenterY = sysGetTileCenter( $gPlayerWorldY )
    *setposworld %PLAYER% $tileCenterX $tileCenterY
}

Notes: There are 2 coordinate systems used in the game ; Map Coordinates range from 0 to 255 (for the default map size), 0 to 511 or 0 to 1023 (if using a larger map size) and they correspond to the 'tiles' that make up the landscape. World coordinates are in centimeters.

Example:

Event( "PlaceAnyBuilding", "" )
{
    $nBuildingType = $gParam[1]

    $numInWorld = sysWorldGetNumBuildingsOfType( $nBuildingType )
    if ( $numInWorld >= 1 )
    {
       *msg %PLAYER% There can only be 1 of each type of building in the world
       CancelTransaction()
    }
    else
    {
	$valid = sysIsBuildingPositionValid( $nBuildingType )
	if ( $valid = 1 )
	{
		$buildingName = sysGetTextEntry()
		$constrAmount = -1
		$didAdd = sysAddBuildingWorld( $nBuildingType,$gPlayerID,$gPlayerWorldX,$gPlayerWorldY,$buildingName,$constrAmount )
	}
    }
}

Example:

$kSpecialBuildingRecordNum = 10

Event( "UseItem", "Plunger" )
{
    SetBuildingContext( $kSpecialBuildingRecordNum )
    $posX = $gBuildingWorldX
    $posY = $gBuildingWorldY
    
    $targetPlayerID = sysGetNearestPlayer( $posX, $posY )
    $targetPlayerName = sysGetPlayerName( $targetPlayerID )
    *say %PLAYER% used the plunger. The person closest to the special building was $targetPlayerName
    *explodebuilding $kSpecialBuildingRecordNum
}

sysActivateBuildingProximityEvent( buildingID, range ) - Activates a proximity trigger for the current player on the specified buildingID.
Used to trigger 4 different events:
Event( “BuildingIDProxEnter”, “BuildingID”) and if that doesnt exist..
Event( “BuildingProxEnter”, “”)
and the reverse..
Event( “BuildingIDProxLeave”, “BuildingID”) and if that doesnt exist..
Event( “BuildingProxLeave”, “”)

sysDeactivateBuildingProximityEvent( buildingID )

sysActivateRangeEvent( eventID, worldX, worldY, range ) - Activates a proximity trigger for the current player using a world coordinate. Atm, eventID is not used, only one range event can be active for the player at any one time. mm, atm seems to only triggers the event “RangeLeave” when a player leaves the range. curious.

sysIsInScriptZone( MapX, MapY, ZoneIDNum ) used to query if the specified map coord is within the specified 'ScriptZone'. Script zones are added via the F10 world editor.

sysNumPlayersInScriptZone( ScriptZoneIDNum ) returns the number of players currently within the specified ScriptZone.

Not yet functional: