ORK Framework
3.17.0
API Documentation
|
Public Member Functions | |
virtual void | UseCraftingRecipe (Combatant combatant, CraftingRecipe recipe, NotifyBool notify) |
Creates the outcome of a crafting recipe. More... | |
virtual void | AddToCraftingList (Combatant combatant, IShortcut item) |
Adds an item to the crafting list of a combatant. More... | |
virtual void | RemoveFromCraftingList (Combatant combatant, IShortcut item) |
Removes an item from the crafting list of a combatant. More... | |
virtual void | ClearCraftingList (Combatant combatant) |
Removes all items in a combatant's crafting list and returns them to the inventory. More... | |
virtual void | CreateFromCraftingList (Combatant combatant, CraftingListCreationType creationType, bool consumeUnused, bool onlyKnownRecipes, Notify finished) |
Creates the outcome of a crafting recipe matching the items in the crafting list of a combatant. More... | |
virtual bool | Add (Inventory inventory, IShortcut item, bool showNotification, bool showConsole, bool markNewContent) |
Adds an item to an inventory. More... | |
virtual IShortcut | Split (Inventory inventory, IShortcut item, int newQuantity) |
Splits an item in the inventory into 2 stacks. More... | |
virtual bool | Merge (Inventory inventory, IShortcut originalShortcut, IShortcut otherShortcut) |
Merges two items in the inventory into a single stack. More... | |
virtual void | Remove (Inventory inventory, IShortcut item, int quantity, bool showNotification, bool showConsole) |
Removes an item from an inventory More... | |
virtual void | Drop (Inventory inventory, IShortcut item, int quantity, bool showNotification, bool showConsole) |
Drops an item from an inventory into the game world. More... | |
virtual void | Drop (Inventory inventory, IShortcut item, int quantity, bool showNotification, bool showConsole, List< GameObject > droppedObjects) |
Drops an item from an inventory into the game world. More... | |
virtual void | SetCurrency (Inventory inventory, Currency currency, int quantity, bool showNotification, bool showConsole) |
Sets the amount of currency in an inventory. More... | |
virtual void | RemoveItemType (Inventory inventory, ItemType itemType, bool removeSubTypes, bool removeCurrency, bool removeItems, bool removeEquipment, bool showNotification, bool showConsole) |
Removes items of an item type from an inventory. More... | |
virtual void | ResetDurability (EquipShortcut equip, Combatant combatant) |
Resets durability of an equipment. More... | |
virtual void | ChangeDurability (EquipShortcut equip, Combatant combatant, float value, SimpleOperator op) |
Changes the durability of an equipment. More... | |
virtual ShopScreen | OpenShop (GameObject shopObject, NotifyBool notifyClosed, ShopSetting setting, string shopID, FactionSetting faction, Combatant user) |
|
virtual |
Adds an item to an inventory.
inventory | The inventory that will be used. |
item | The item that will be added. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
markNewContent | true if the item should be marked as new content. |
true
if the item was added.
|
virtual |
Adds an item to the crafting list of a combatant.
combatant | The used combatant. |
item | The item that will be added. |
|
virtual |
Changes the durability of an equipment.
equip | The instance of the equipment. |
combatant | The combatant used for the change (e.g. in case durability uses a formula). |
value | The value the durability will be changed by. |
op | The operator used for the change. |
|
virtual |
Removes all items in a combatant's crafting list and returns them to the inventory.
combatant | The used combatant. |
|
virtual |
Creates the outcome of a crafting recipe matching the items in the crafting list of a combatant.
combatant | The used combatant. |
creationType | The creation type used (Exact, One, Multi). |
consumeUnused | true if unused items in the crafting list should be consumed. |
onlyKnownRecipes | true if only crafting recipes that are known to the combatant should be used. |
|
virtual |
Drops an item from an inventory into the game world.
inventory | The inventory that will be used. |
item | The item that will be dropped. |
quantity | The quantity that will be dropped. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
|
virtual |
Drops an item from an inventory into the game world.
inventory | The inventory that will be used. |
item | The item that will be dropped. |
quantity | The quantity that will be dropped. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
droppedObjects | Game objects of dropped items will be added to this list. |
|
virtual |
Merges two items in the inventory into a single stack.
inventory | The inventory that will be used. |
originalShortcut | The shortcut that will be added to. |
otherShortcut | The shortcut that will be removed from. |
true
if the shortcuts where merged.
|
virtual |
Removes an item from an inventory
inventory | The inventory that will be used. |
item | The item that will be removed. |
quantity | The quantity that will be removed. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
|
virtual |
Removes an item from the crafting list of a combatant.
combatant | The used combatant. |
item | The item that will be removed. |
|
virtual |
Removes items of an item type from an inventory.
inventory | The inventory that will be used. |
itemType | The item type that will be removed. |
removeSubTypes | true if sub types of the item type should be removed. |
removeCurrency | true if currency should be removed. |
removeItems | true if items should be removed. |
removeEquipment | true if equipment should be removed. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
|
virtual |
Resets durability of an equipment.
equip | The instance of the equipment. |
combatant | The combatant used for resetting durability (e.g. in case durability uses a formula). |
|
virtual |
Sets the amount of currency in an inventory.
inventory | The inventory that will be used. |
currency | The currency. |
quantity | The quantity the currency will be set to. |
showNotification | true if a notification should be displayed. |
showConsole | true if a console line should be added. |
|
virtual |
Splits an item in the inventory into 2 stacks.
inventory | The inventory that will be used. |
item | The item that will be split. |
newQuantity | The quantity of the new stack (removed from old stack). |
|
virtual |
Creates the outcome of a crafting recipe.
combatant | The combatant used to craft. |
recipe | The crafting recipe. |
notify | A callback function taking a bool parameter (true if crafting was successful). |