Eco - English Wiki - User contributions [en]

Mod Server API

2022-02-12T19:31:13Z

Salbris:

== 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.

To make full use of these docs you will want to have a basic understanding of the C# language and related concepts.
== 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:
user.Player
Or vice-versa:
player.User
=== 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:
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 [[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.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> 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.

=== 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 ==
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 ===
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:
foreach (ItemStack stack in backpack.NonEmptyStacks)
{
...
}

IEnumerable<ItemStack> stacks = user.Inventory.AllInventories.SelectMany(i => i.Stacks);
To access the item in the stack use <code>stack.Item</code> and use <code>stack.Quantity</code> to get the amount of items in that stack.
[[Category:Modding]]

Mod Server API

2022-02-12T18:50:22Z

Salbris:

== 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.

To make full use of these docs you will want to have a basic understanding of the C# language and related concepts.
== 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:
user.Player
Or vice-versa:
player.User
=== 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:
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 [[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.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> 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.

== 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.
=== 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:
foreach (ItemStack stack in backpack.NonEmptyStacks)
{
...
}

IEnumerable<ItemStack> stacks = user.Inventory.AllInventories.SelectMany(i => i.Stacks);
To access the item in the stack use <code>stack.Item</code> and use <code>stack.Quantity</code> to get the amount of items in that stack.
[[Category:Modding]]

Mod Server API

2022-02-12T18:48:26Z

Salbris:

== 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.

To make full use of these docs you will want to have a basic understanding of the C# language and related concepts.
== 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:
user.Player
Or vice-versa:
player.User
=== 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:
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 [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.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> 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.

== 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.

=== 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:
foreach (ItemStack stack in backpack.NonEmptyStacks)
{
...
}

IEnumerable<ItemStack> stacks = user.Inventory.AllInventories.SelectMany(i => i.Stacks);
To access the item in the stack use <code>stack.Item</code> and use <code>stack.Quantity</code> to get the amount of items in that stack.
[[Category:Modding]]

Mod Server API

2022-02-12T18:18:03Z

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

Mod Server API

2022-02-12T02:48:55Z

Salbris: More additions to the player inventory docs.

Mod Server API

2022-02-11T20:40:27Z

Salbris: Updated Player and Player Inventory sections

Mod Server API

2022-02-11T20:24:34Z

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..."

Creating Custom Blocks

2022-02-01T20:29:41Z

Salbris: Started to add a few more steps to the tutorial.

[[File:Stained Glass Block.png|frame]]
This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.
https://github.com/StrangeLoopGames/EcoModKit/tree/main/Examples/Blockset
== Initial Scene Setup ==
Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
[[File:BlockSetContainerStructure.png|none|thumb|542x542px]]
== Creating your BlockSet ==
The first step to implementing a block into your new BlockSetContainer is by creating a BlockSet object inside the Unity asset explorer. A BlockSet represents one block type within the project. It contains the BlockBuilder objects used to represent each form of the new block as well as visual properties about how it should be rendered. To create a new BlockSet right click inside the Unity asset explorer and click Create -> VoxelEngine -> BlockSet. The name of the newly created BlockSet file is not important for the mod to function however for best practice it should be named similar to the internal or display name of the new block. Once the file is created attach it to the BlockSetContainer made in the previous step.
[[File:BlockSet Menu Location.png|none|thumb]]

== Creating your first BlockBuilder ==
[[File:Green Stained Glass BlockSet.png|thumb]]
A BlockBuilder represents a single form of a block inside Eco and defines the rules and meshes used to display it in the world. For the purposes of this tutorial we will be creating seven BlockBuilder objects for our new BlockSet. This list includes three block forms and four builders to represent the various stack states.
* GreenStainedGlassWindow
* GreenStainedGlassStacked1
* GreenStainedGlassStacked2
* GreenStainedGlassStacked3
* GreenStainedGlassStacked4
* GreenStainedGlassCube
* GreenStainedGlassFlatRoof

The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.

== Add Meshes and materials to Builders ==
For each block you created above select them and add your material just below where you assigned your builder.
[[File:UnityBlockMatScreen.png|none|thumb]]

== Common Bugs ==
Below are a list of common bugs encountered while making custom blocks and how to solve them.
==== My block does not appear using the right mesh or in the spot I placed it. ====
This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
[[File:OptimizeMeshData-Unity-PlayerSettings.png|none|thumb|462x462px]]
==== My block is changing changing between my material and a different material ====
This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.
[[Category:Modding]]
{{DEFAULTSORT:CreatingCustomBlocks}}

Arctic Willow

2020-10-10T18:03:51Z

Salbris:

{{contentneeded}}
{{Infobox_Plant|plant=Arctic Willow}}

[[Arctic Willow]] is a low lying shrub found in the [[Boreal Forest]] and [[Tundra]]. It can be harvested with a [[Sickle]] to obtain [[Plant Fibers]].

==Farming Conditions==
{{PlantDetails|plant=Arctic Willow}}

===See Also===
For more Farming information, see [[Agriculture]].

[[Category:Plants]]

Agouti

2020-10-10T17:57:32Z

Salbris:

{{ContentNeeded}}
{{Infobox_Animal| name = Agouti}}

[[Agouti]] is a small rodent found throughout the [[Rainforest]]. It can be hunted to obtain [[Tiny Animal Carcass]] for use in [[Campfire Cooking]] and [[Butchery]].

==See Also==
For a list of animals, see [[Animals]].

{{Description|item=Agouti}}

[[Category: Animals]]

Agave Leaves

2020-10-10T17:44:36Z

Salbris: Added an opening paragraph.

{{Infobox_Item|name=Agave Leaves}}

[[Agave Leaves]] are a food item gathered by using a [[Sickle]] on an [[Agave]] plant. They are primarily used in low level cooking recipes through the "Greens" tag.

==Crafting==
{{GetRecipes|item=Agave Leaves}}

[[Category:Food]]

[[de:Agavenblätter]]

Epoxy

2020-10-10T05:35:38Z

Salbris: Added an opening paragraph describing the item.

{{Infobox_Item|name=Epoxy}}

[[Epoxy]] is an intermediate product crafted at the [[Oil Refinery]]. It is used in a variety of late game crafting recipes including [[Composite Lumber]], [[Flat Steel]], and other intermediate parts.




{{Description|item=Epoxy}}

== Crafting ==
{{GetRecipes|item=Epoxy}}

==Videos==
{{#ev:youtube|dz67fu3w3nQ}}

== Gallery ==
<gallery>File:Epoxy_Details.png|[[Epoxy]] item details as of Alpha v6.3.1.</gallery>

[[Category: Items]]