Script v1.7.1.0

• AI
• Animals
• Contracts
• Debug
• Economy
• Effects
• Events
• Farms
• AccessHandler
• Farm
• FarmManager
• FarmStats
• FinanceStats
• GUI
• Handtools
• I3d
• Materials
• Misc
• Objects
• Placeables
• Player
• Shop
• Sounds
• Specializations
• Triggers
• Utils
• Vehicles
• Weather

Engine v1.7.1.0

• AI
• Animation
• Camera
• Entity
• Fillplanes
• General
• I3D
• Input
• Lighting
• Math
• Network
• Node
• Overlays
• Particle System
• Physics
• Rendering
• Scenegraph
• Shape
• Sound
• Spline
• String
• Terrain Detail
• Text Rendering
• Tire Track
• XML
• general

Foundation Reference

• Scenegraph
• Input

Farm

Permission types.

Object

• addHandTool
• addUser
• calculateDailyLoanInterest
• changeBalance
• demoteUser
• getActiveUsers
• getBalance
• getColor
• getEquity
• getFarmhouse
• getHandTools
• getIsContractingFor
• getLoan
• getNumActivePlayers
• getNumPlayers
• getSleepCamera
• getSpawnPoint
• getUserPermissions
• hasHandtool
• isUserFarmManager
• loadFromXMLFile
• merge
• new
• onUserJoinGame
• onUserQuitGame
• promoteUser
• removeHandTool
• removeUser
• resetToSingleplayer
• saveToXMLFile
• setInitialEconomy
• setIsContractingFor
• setUserPermission
• updateLastNickname
• updateMaxLoan

addHandTool

Add ownership of given handtool

addHandTool()

addUser

Add a new user to the farm. This adds it to the players and active players list. And also gives default permissions.

addUser()

calculateDailyLoanInterest

Calculate the daily loan interest

calculateDailyLoanInterest()

changeBalance

Add or remove money from the farm

changeBalance(number amount)

demoteUser

Demote a user from farm manager.

demoteUser()

getActiveUsers

Get a list of active users. Useful for using their connection ID

getActiveUsers()

getBalance

Get the current account balance of the farm.

getBalance()

getColor

Get the farm color

getColor()

getEquity

Get the total equity (farmlands + placeables) of the farm

getEquity()

getFarmhouse

Get the farmhouse associated with the farm.

getFarmhouse()

getHandTools

Get a list of filenames for accessible handtools

getHandTools()

getIsContractingFor

Get whether this farm is contracting for given farm

getIsContractingFor()

getLoan

Get the current loan of the farm.

getLoan()

getNumActivePlayers

Get the number of players in the farm that are currently online

getNumActivePlayers()

getNumPlayers

Get the number of players in the farm

getNumPlayers()

getSleepCamera

Get the sleep camera.

getSleepCamera()

getSpawnPoint

Get the spawnpoint associated with the farm(house).

getSpawnPoint()

getUserPermissions

Get the farm permissions of a user.

getUserPermissions(userId User)

hasHandtool

Get whether this farm owns given handtool

hasHandtool()

isUserFarmManager

Determine if a user is a manager of this farm.

isUserFarmManager(userId User)

loadFromXMLFile

Load the farm from the savegame

loadFromXMLFile()

merge

Merge another farm into this farm. Used for creating an SP game from an MP game. (this is mutating)

merge(table other)

new

Create a new farm. Do not call directly! Only use the farm manager and createFarm()

new()

onUserJoinGame

Called when a user joins the game. Active users is updated, and for spectator. a new user might be added. Server only.

onUserJoinGame()

onUserQuitGame

Called when a user quits the game. The active user list is updated. Server only.

onUserQuitGame()

promoteUser

Promote a user to farm manager.

promoteUser()

removeHandTool

Remove ownership of given handtool

removeHandTool()

removeUser

Remove a user from the farm.

removeUser()

resetToSingleplayer

Reset the farm to a singleplayer state by removing all players and adding a new single player with all permissions

resetToSingleplayer()

saveToXMLFile

Save the farm to the savegame

saveToXMLFile()

setInitialEconomy

setInitialEconomy()

setIsContractingFor

Update contracting status

setIsContractingFor(noSendEvent boolean)

setUserPermission

Set a user's permission in this farm.

setUserPermission(userId User, string permission, bool hasPermission)

updateLastNickname

updateLastNickname()

updateMaxLoan

Re-calculate the maximum loan

updateMaxLoan()