Mod Server API - Revision history

StalEF at 05:38, 28 April 2024

2024-04-28T05:38:53Z

← Older revision		Revision as of 07:38, 28 April 2024
Line 18:		Line 18:
	user.Inventory.Toolbar		user.Inventory.Toolbar
	The items in these inventories can be accessed in a couple different ways as discussed in the [[Mod Server API#Inventory\|Inventory Section]]. Each of these is an instance of [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory].		The items in these inventories can be accessed in a couple different ways as discussed in the [[Mod Server API#Inventory\|Inventory Section]]. Each of these is an instance of [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory].
	~~[[File:ActionBarScreenshot.png\|thumb\|user.Inventory.ActionBar]]~~
	<code>user.Inventory.ActionBar</code> represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.		<code>user.Inventory.ActionBar</code> represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.

Line 26:		Line 26:

	<code>user.Inventory.Clothing</code> represents the items of clothing the player is wearing.		<code>user.Inventory.Clothing</code> represents the items of clothing the player is wearing.
	~~[[File:ToolbarScreenshot.png\|thumb\|user.Inventory.Toolbar]]~~
	<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.		<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.

Salbris at 19:31, 12 February 2022

2022-02-12T19:31:13Z

← Older revision		Revision as of 21:31, 12 February 2022
Line 29:		Line 29:
	<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.		<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.



			=== World Objects - Crafting Tables, Storage, and Vehicles ===
			Crafting tables, vehicles, stockpiles, and other placed structures are represented by the <code>WorldObject</code> class. The walls, roof, roads, etc are not considered world objects. To list all the world objects owned by the player use the following static method:
			WorldObject.GetOwnedBy(user) //IEnumerable<WorldObject>
			Each <code>WorldObject</code> contains components that represent their features. For example, the <code>StorageComponent</code> represents the ability for the object to store items as stacks.

			==== Crafting Component ====
			The crafting component represents a crafting tables work orders, recipes, etc.

	== Inventory ==		== Inventory ==

Salbris at 18:50, 12 February 2022

2022-02-12T18:50:22Z

← Older revision		Revision as of 20:50, 12 February 2022
Line 17:		Line 17:
	user.Inventory.Clothing		user.Inventory.Clothing
	user.Inventory.Toolbar		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 [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory].		The items in these inventories can be accessed in a couple different ways as discussed in the [[Mod Server API#Inventory\|Inventory Section]]. Each of these is an instance of [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory].
	[[File:ActionBarScreenshot.png\|thumb\|user.Inventory.ActionBar]]		[[File:ActionBarScreenshot.png\|thumb\|user.Inventory.ActionBar]]
	<code>user.Inventory.ActionBar</code> represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.		<code>user.Inventory.ActionBar</code> represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.
Line 28:		Line 28:
	[[File:ToolbarScreenshot.png\|thumb\|user.Inventory.Toolbar]]		[[File:ToolbarScreenshot.png\|thumb\|user.Inventory.Toolbar]]
	<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.		<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.



	== Inventory ==		== Inventory ==
	An [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory] is a collection of item stacks and is used to represent the items inside various things in Eco including the player's backpack, vehicles, storage chests, stockpiles, and even fuel slots. Each instance of Inventory has a common interface for getting access to the items and stacks inside it. Inventories are also a hierarchy of inventories. For example, the player has a root level inventory <code>user.Inventory</code> which represents all the inventories of the player's character (their backpack, toolbar and clothing). To access child inventories you can use <code>inventory.AllInventories</code> or just by accessing the same stacks <code>IEnumerable</code> properties mentioned below.		An [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory] is a collection of item stacks and is used to represent the items inside various things in Eco including the player's backpack, vehicles, storage chests, stockpiles, and even fuel slots. Each instance of Inventory has a common interface for getting access to the items and stacks inside it. Inventories are also a hierarchy of inventories. For example, the player has a root level inventory <code>user.Inventory</code> which represents all the inventories of the player's character (their backpack, toolbar and clothing). To access child inventories you can use <code>inventory.AllInventories</code> or just by accessing the same stacks <code>IEnumerable</code> properties mentioned below.

	=== Items/Stacks ===		=== Items/Stacks ===
	Each slot of the inventory is represented by the [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.ItemStack.html ItemStack] class whether it is empty or not. You can access the individual items through the inventory's stacks. Use <code>inventory.Stacks</code> to access all the stacks or <code>inventory.NonEmptyStacks</code> to access just the slots with any items in them. Both of these are <code>IEnumberable<ItemStack></code> so they can be used with [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/ Linq] or iterated through in a for-each loop:		Each slot of the inventory is represented by the [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.ItemStack.html ItemStack] class whether it is empty or not. You can access the individual items through the inventory's stacks. Use <code>inventory.Stacks</code> to access all the stacks or <code>inventory.NonEmptyStacks</code> to access just the slots with any items in them. Both of these are <code>IEnumberable<ItemStack></code> so they can be used with [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/ Linq] or iterated through in a for-each loop:

Salbris at 18:48, 12 February 2022

2022-02-12T18:48:26Z

@@ Line 1: / Line 1: @@
 == 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 <code>User</code> and <code>Player</code> class contain references to information about a specific player. The <code>User</code> class contains references to the player's owned objects, inventories, their stats, professions, etc. While the <code>Player</code> class has references to their location, technical server properties, player name, etc. If you have a <code>User</code> and need to get a <code>Player</code> instance it's as simple as:
@@ Line 22: / Line 24: @@
 <code>user.Inventory.Carried</code> represents the stack of items the player can carry around such as dirt, stone, or logs.
 <code>user.Inventory.Clothing</code> represents the items of clothing the player is wearing.
 [[File:ToolbarScreenshot.png|thumb|user.Inventory.Toolbar]]
 <code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.

Salbris: /* Accessing the Player's Inventory */

2022-02-12T18:18:03Z

Accessing the Player's Inventory

← Older revision		Revision as of 20:18, 12 February 2022
Line 9:		Line 9:
	All of a player's inventory is referenced by the <code>UserInventory</code> class which is accessed by the Inventory property:		All of a player's inventory is referenced by the <code>UserInventory</code> class which is accessed by the Inventory property:
	user.Inventory		user.Inventory
	The player's backpack, ~~action bar, carried items~~ and clothing can be accessed through this object like this:		The player's backpack, toolbar and clothing can be accessed through this object like this:
			user.Inventory.ActionBar
	user.Inventory.Backpack		user.Inventory.Backpack
	~~user.Inventory.ActionBar~~
	user.Inventory.Carried		user.Inventory.Carried
	user.Inventory.Clothing		user.Inventory.Clothing
	The items in these inventories can be accessed in a couple different ways as discussed ~~here (TBD link to generic inventories section)~~		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 [https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.Items.Inventory.html Inventory].
	~~<code>user.~~Inventory.~~Backpack</code>~~ is an ~~Inventory~~ instance ~~that lists all the stacks~~ of ~~items inside the player's backpack but not their clothes or items on their hotbar~~.		[[File:ActionBarScreenshot.png\|thumb\|user.Inventory.ActionBar]]
			<code>user.Inventory.ActionBar</code> represents all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.
	<code>user.Inventory.ActionBar</code>~~is an Inventory instance that lists~~ all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.

	~~What the action bar looks like in-game:~~
	~~[[File:ActionBarScreenshot.png\|left\|thumb\|user.Inventory.ActionBar]]~~





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

	<code>user.Inventory.Carried</code> ~~is an Inventory instance that~~ represents the stack of items the player can carry around such as dirt, stone, or logs.		<code>user.Inventory.Carried</code> represents the stack of items the player can carry around such as dirt, stone, or logs.
			<code>user.Inventory.Clothing</code> represents the items of clothing the player is wearing.
			[[File:ToolbarScreenshot.png\|thumb\|user.Inventory.Toolbar]]
			<code>user.Inventory.Toolbar</code> represents the items on the player's toolbar where they put tools and other items they want quick access to.

Salbris: More additions to the player inventory docs.

2022-02-12T02:48:55Z

More additions to the player inventory docs.

← Older revision		Revision as of 04:48, 12 February 2022
Line 6:		Line 6:
	Or vice-versa:		Or vice-versa:
	player.User		player.User

	=== Accessing the Player's Inventory ===		=== Accessing the Player's Inventory ===
	All of a player's inventory is referenced by the <code>UserInventory</code> class which is accessed by the Inventory property:		All of a player's inventory is referenced by the <code>UserInventory</code> class which is accessed by the Inventory property:
	user.Inventory		user.Inventory
	The player's backpack, action bar, carried items and clothing can be accessed through this object:		The player's backpack, action bar, carried items and clothing can be accessed through this object like this:
	user.Inventory.Backpack		user.Inventory.Backpack
	user.Inventory.ActionBar		user.Inventory.ActionBar
	user.Inventory.Carried		user.Inventory.Carried
	user.Inventory.Clothing		user.Inventory.Clothing
			The items in these inventories can be accessed in a couple different ways as discussed here (TBD link to generic inventories section)

			<code>user.Inventory.Backpack</code> is an Inventory instance that lists all the stacks of items inside the player's backpack but not their clothes or items on their hotbar.

			<code>user.Inventory.ActionBar</code>is an Inventory instance that lists all the standard buttons used to open the backpack, economy viewer, etc. located next to the minimap.

			What the action bar looks like in-game:
			[[File:ActionBarScreenshot.png\|left\|thumb\|user.Inventory.ActionBar]]






			<code>user.Inventory.Carried</code> is an Inventory instance that represents the stack of items the player can carry around such as dirt, stone, or logs.

Salbris: Updated Player and Player Inventory sections

2022-02-11T20:40:27Z

Updated Player and Player Inventory sections

← Older revision		Revision as of 22:40, 11 February 2022
Line 1:		Line 1:
	== Introduction ==		== 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.		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 ==		== Player ==
	The User and Player class contain references to the ~~Player~~'s owned objects, inventories, their stats, professions, etc. If you have a User and need to get a Player instance it's as simple as:		The <code>User</code> and <code>Player</code> class contain references to information about a specific player. The <code>User</code> class contains references to the player's owned objects, inventories, their stats, professions, etc. While the <code>Player</code> class has references to their location, technical server properties, player name, etc. If you have a <code>User</code> and need to get a <code>Player</code> instance it's as simple as:
			user.Player
	~~<nowiki>~~user.Player~~</nowiki>~~		Or vice-versa:
			player.User

	=== Accessing the Player's Inventory ===		=== Accessing the Player's Inventory ===
			All of a player's inventory is referenced by the <code>UserInventory</code> class which is accessed by the Inventory property:
	<~~nowiki~~>player.Inventory.Backpack~~</nowiki>~~		user.Inventory
			The player's backpack, action bar, carried items and clothing can be accessed through this object:
			user.Inventory.Backpack
			user.Inventory.ActionBar
			user.Inventory.Carried
			user.Inventory.Clothing

Salbris: Created page with "== 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 the Player's owned objects, inventories, their stats, professions, etc. If you have a User and need to get a Player instance it's as..."

2022-02-11T20:24:34Z

Created page with "== 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 the Player's owned objects, inventories, their stats, professions, etc. If you have a User and need to get a Player instance it's as..."

New page

== 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 the Player's owned objects, inventories, their stats, professions, etc. If you have a User and need to get a Player instance it's as simple as:

<nowiki>user.Player</nowiki>

=== Accessing the Player's Inventory ===

<nowiki>player.Inventory.Backpack</nowiki>