Interface IMyStoreBlock
Describes store block (mods interface)
Inherited Members
Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common.dll
Syntax
public interface IMyStoreBlock : IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity, IMyStoreBlock, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityMethods
CreateStoreItem(Int32, Int32, StoreItemTypes, ItemTypes)
Creates a store item that allows more control over how the item is setup. This method is suitable for Hydrogen and Oxygen types.
Declaration
IMyStoreItem CreateStoreItem(int amount, int pricePerUnit, StoreItemTypes storeItemType, ItemTypes itemType)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | amount | Amount that should be available to buy/sell |
| System.Int32 | pricePerUnit | Individual cost per item |
| StoreItemTypes | storeItemType | Offer (store is selling) or Order (store is buying) |
| ItemTypes | itemType |
Returns
| Type | Description |
|---|---|
| IMyStoreItem | Result of the creation of the store item. |
CreateStoreItem(String, Int32, Int32, Int32)
Creates a store item that sells a Prefab / Grid.
Declaration
IMyStoreItem CreateStoreItem(string prefabName, int amount, int pricePerUnit, int totalPcu)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | prefabName | The SubtypeId of a prefab that is being sold |
| System.Int32 | amount | Amount that should be available to buy/sell |
| System.Int32 | pricePerUnit | Individual cost per item |
| System.Int32 | totalPcu | The prefab PCU value |
Returns
| Type | Description |
|---|---|
| IMyStoreItem | Result of the creation of the store item. |
CreateStoreItem(MyDefinitionId, Int32, Int32, StoreItemTypes)
Creates a store item that allows more control over how the item is setup. This method is suitable for PhysicalItem types.
Declaration
IMyStoreItem CreateStoreItem(MyDefinitionId itemId, int amount, int pricePerUnit, StoreItemTypes storeItemType)Parameters
| Type | Name | Description |
|---|---|---|
| MyDefinitionId | itemId | Item definition id |
| System.Int32 | amount | Amount that should be available to buy/sell |
| System.Int32 | pricePerUnit | Individual cost per item |
| StoreItemTypes | storeItemType | Offer (store is selling) or Order (store is buying) |
Returns
| Type | Description |
|---|---|
| IMyStoreItem | Result of the creation of the store item. |
CreateStoreItem(MyObjectBuilder_StoreItem)
Creates a store item that allows more control over how the item is setup by using an object builder to initialize the item.
Declaration
IMyStoreItem CreateStoreItem(MyObjectBuilder_StoreItem builder)Parameters
| Type | Name | Description |
|---|---|---|
| MyObjectBuilder_StoreItem | builder | The object builder used to init the store item |
Returns
| Type | Description |
|---|---|
| IMyStoreItem | Result of the creation of the store item. |
GetStoreItemById(Int64)
Gets a store item using a provided id.
Declaration
IMyStoreItem GetStoreItemById(long id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | The id of the store item being sold |
Returns
| Type | Description |
|---|---|
| IMyStoreItem | Store item matching provided id. Returns null if not found |
GetStoreItems(List<IMyStoreItem>)
Gets all the current items in a store block
Declaration
void GetStoreItems(List<IMyStoreItem> items)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<IMyStoreItem> | items | A provided list that will be populated with the items in the store |
InsertOffer(MyStoreItemData, out Int64)
Creates store item and returns its id.
Declaration
MyStoreInsertResults InsertOffer(MyStoreItemData item, out long id)Parameters
| Type | Name | Description |
|---|---|---|
| MyStoreItemData | item | Data defining the store item. |
| System.Int64 | id | Id of the item in the shop. (Ex. needed to remove the item) |
Returns
| Type | Description |
|---|---|
| MyStoreInsertResults | Result of the creation of the store item. |
InsertOrder(MyStoreItemData, out Int64)
Creates store item and returns its id.
Declaration
MyStoreInsertResults InsertOrder(MyStoreItemData item, out long id)Parameters
| Type | Name | Description |
|---|---|---|
| MyStoreItemData | item | Data defining the store item. |
| System.Int64 | id | Id of the item in the shop. (Ex. needed to remove the item) |
Returns
| Type | Description |
|---|---|
| MyStoreInsertResults | Result of the creation of the store item. |
InsertStoreItem(IMyStoreItem)
Allows you to add an item to a store block. This is a direct add and does not involve any listing fees, etc.
Declaration
void InsertStoreItem(IMyStoreItem item)Parameters
| Type | Name | Description |
|---|---|---|
| IMyStoreItem | item | The item you want to add |
RemoveStoreItem(IMyStoreItem)
Allows you to remove an item to a store block.
Declaration
void RemoveStoreItem(IMyStoreItem item)Parameters
| Type | Name | Description |
|---|---|---|
| IMyStoreItem | item | The item you want to remove |