The Universal World Owner's Manual

System functions that provide information about a building and its contents, and allow you to control the building UI.

Unless otherwise stated, these functions refer to the building currently being accessed by the player. (This can be overriden using SetBuildingContext).

Example:

Event( "AccessBuilding", "2" )
{
    $buyPrice = sysGetBuyPrice( "Flour" )
    $buyPriceText = sysGetPriceText( $buyPrice )

    osdcreate( OSDBUILDING, "BakeryOSD", "Bakery" )
    osdadd( 200, 100, 200, 40, "Sell|Flour", "Buying flour ($buyPriceText)" )
    osdactivate()
}

Example:

Event( "AccessBuilding", "12" )
{
    osdcreate( OSDBUILDING, "Building", "Example" )
    $woodSellPrice = sysGetSellPrice( "Wood" )  
    if ( $woodSellPrice == 0 )
    {
        osdadd( TEXT, 100, 100, 400, 0, "", "Not currently selling wood" )   
    }
    else
    { 
        $woodSellPriceText = sysGetPriceText( $woodSellPrice )
        osdadd( TEXT, 100, 100, 400, 0, "", "Currently selling wood at $woodSellPriceText" )
    }
    osdactivate()
}

Example:

Event( "AccessBuilding", "13" )
{
    osdcreate( OSDBUILDING, "Building", "Example" )
    $employeeID = sysGetEmployeeID( 0 )
    if ( $employeeID != 0 )
    {
        $employeeName = sysGetPlayerName( $employeeID )
        osdadd( TEXT, 100, 100, 400, 0, "", "Employee : $employeeName" )   
    }
    else
    { 
        osdadd( TEXT, 100, 100, 400, 0, "", "There is no-one currently employed at this building" )
    }
    osdactivate()
}

Example:

Event( "UseItem", "Map" )
{
    $nearestTownID = sysGetNearestTown( $gPlayerWorldX, $gPlayerWorldY )
    $nearestTownName = sysGetBuildingName( $nearestTownID )
    *msg %PLAYER% The nearest town is $nearestTownName
}

TBD

Various information the context building is provided through System Values - relevant ones are:

$gBuildingX, $gBuildingY : X,Y location of the building in map coords (default 0 → 255)
$gBuildingCode : Building type code - the number of the building type in the buildings editor list
$gBuildingNum, $gBuildingAccessNum : Unique ID number of the specific building being accessed
$gBuildingWorldX, $gBuildingWorldY : X,Y location of the building in world coords
$gBuildingTeam : Team the building belongs to (or 0 if none)
$gBuildingCapacity : Capacity value of the building (e.g. for homes)
$gBuildingSpaceRemaining : Remaining capacity of the building (e.g. for homes)
$gBuildingTown : Town building num of the town the building is in (or 0 if the building is not in a town)
$gBuildingScriptParam, , $gBuildingOwnerID, $gBuildingNumEmployees, $gBuildingMaxEmployees, $gBuildingSalePrice, $gBuildingWage, $gBuildingInvestment, $gBuildingEfficiency, $gBuildingScore, $gBuildingType, $gBuildingDamage,

The following functions are somewhat different.. rather than being about a specific building, they return information about all the buildings a player currently owns.