Interface IMyStoreBlock
Describes store block (PB scripting interface)
Inherited Members
Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Syntax
public interface IMyStoreBlock : IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityMethods
CancelStoreItem(Int64)
Cancels the item (either order or offer).
Declaration
bool CancelStoreItem(long id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | Id of the item to be canceled. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if item was canceled |
GetPlayerStoreItems(List<MyStoreQueryItem>)
Returns player store items.
Declaration
void GetPlayerStoreItems(List<MyStoreQueryItem> storeItems)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<MyStoreQueryItem> | storeItems | Returns items currently set in store. |
InsertOffer(MyStoreItemDataSimple, out Int64)
Creates store item offer and returns its id.
Declaration
MyStoreInsertResults InsertOffer(MyStoreItemDataSimple item, out long id)Parameters
| Type | Name | Description |
|---|---|---|
| MyStoreItemDataSimple | 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(MyStoreItemDataSimple, out Int64)
Creates store item order and returns its id.
Declaration
MyStoreInsertResults InsertOrder(MyStoreItemDataSimple item, out long id)Parameters
| Type | Name | Description |
|---|---|---|
| MyStoreItemDataSimple | 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. |