Mod Server API

Introduction

This page provides some tips for how to interact with the Server API when you create mod that needs to interact with the game's runtime state or behaviour. A full comprehensive list of the entire API can be found at https://docs.play.eco/api/server/index.html.

Player

The User and Player class contain references to information about a specific player. The User class contains references to the player's owned objects, inventories, their stats, professions, etc. While the Player class has references to their location, technical server properties, player name, etc. If you have a User and need to get a Player instance it's as simple as:

user.Player

Or vice-versa:

player.User

Accessing the Player's Inventory

All of a player's inventory is referenced by the UserInventory class which is accessed by the Inventory property:

user.Inventory

The player's backpack, toolbar and clothing can be accessed through this object like this:

user.Inventory.ActionBar
user.Inventory.Backpack
user.Inventory.Carried
user.Inventory.Clothing
user.Inventory.Toolbar

The items in these inventories can be accessed in a couple different ways as discussed in the Inventory Section. Each of these is an instance of Inventory.

File:ActionBarScreenshot.png

user.Inventory.ActionBar

user.Inventory.ActionBar represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.

user.Inventory.Backpack represents all the stacks of items inside the player's backpack but not their clothes or items on their hotbar.

user.Inventory.Carried represents the stack of items the player can carry around such as dirt, stone, or logs. user.Inventory.Clothing represents the items of clothing the player is wearing.

File:ToolbarScreenshot.png

user.Inventory.Toolbar

user.Inventory.Toolbar represents the items on the player's toolbar where they put tools and other items they want quick access to.