Docs For Class buildingFunctions

Description

Functions for class buildingMainPage.

author: Zoltán Császár <gomor@users.sourceforge.net>
see: buildingMainPage

Located in /lib/php/buildingfuncs.php (line 33)

Method Summary

integer getCurentRound (mixed $connection)

text tryToBuild (mixed $building, mixed $amount, mixed $countryID, mixed $connection)

text tryToDemo (mixed $building, mixed $amount, mixed $countryID, mixed $connection)

text tryToSetImportance (mixed $countryID, mixed $building, mixed $newIportance, mixed $connection)

text tryToStop (mixed $stopBuildingType, mixed $stopBuildingAmount, mixed $stopBuildingRound, mixed $countryID, mixed $connection)

Methods

getCurentRound (line 150)

Called from buildinglist.php getCurentRound method.

Calls buildingfuncs_db.php's getCurentRound() method

integer getCurentRound (mixed $connection)

tryToBuild (line 68)

Called from buildinglist.php tryToBuild method.

Calls buildingfuncs_db.php's buildBuilding method.

return: OK|NOK(in case of Query Error)
see: buildingfuncs_db::buildBuilding()
see: buildingMainPage::tryToBuild()

text tryToBuild (mixed $building, mixed $amount, mixed $countryID, mixed $connection)

tryToDemo (line 43)

Called from buildinglist.php tryToDemo method.

Calls buildingfuncs_db.php's demolishBuilding method.

return: OK|NOK(in case of Query Error)
see: buildingfuncs_db::demolishBuilding()
see: buildingMainPage::tryToDemo()

text tryToDemo (mixed $building, mixed $amount, mixed $countryID, mixed $connection)

tryToSetImportance (line 94)

Called from buildinglist.php tryToSetImportance method.

Calls buildingfuncs_db.php's setImportance method if the requested value is between 0 and the amount of the buildings exists in the game.

return: OK|NOK(in case of Query Error)
see: buildingfuncs_db::setImportance()
see: buildingfuncs_db::getBuildingTypeAmount()
see: buildingMainPage::tryToSetImportance()

text tryToSetImportance (mixed $countryID, mixed $building, mixed $newIportance, mixed $connection)

tryToStop (line 123)

Called from buildinglist.php tryToStop method.

Calls buildingfuncs_db.php's stopBuilding method if the requested value is correct ie. there are at least as many buildings under construction as many requested to stop.

return: OK|NOK(in case of Query Error)
see: buildingfuncs_db::stopBuilding()
see: buildingfuncs_db::getBuildingUCInRound()
see: buildingMainPage::tryToStop()

text tryToStop (mixed $stopBuildingType, mixed $stopBuildingAmount, mixed $stopBuildingRound, mixed $countryID, mixed $connection)