EVEngine: eve::inventory::InventorySystem类参考

载入中...

搜索中...

未找到

#include <InventorySystem.h>

Public 类型
using	AcceptFn = std::function< bool(const Bag &bag, const ItemDefinition &def, int quantity, std::string *reason)>

using	CapacityFn = std::function< bool(const Bag &bag, const ItemDefinition &def, int quantity, std::string *reason)>

using	StackFn = std::function< bool(const ItemStack &a, const ItemStack &b, const ItemDefinition &def)>

using	ChangeHook = std::function< void(const InventoryChangeEvent &ev)>

静态 Public 成员函数
static void	registerAcceptRule (const std::string &name, AcceptFn fn)

static void	unregisterAcceptRule (const std::string &name)

static bool	hasAcceptRule (const std::string &name)

static void	registerCapacityPolicy (const std::string &name, CapacityFn fn)

static void	unregisterCapacityPolicy (const std::string &name)

static bool	hasCapacityPolicy (const std::string &name)

static void	registerStackRule (const std::string &name, StackFn fn)

static void	unregisterStackRule (const std::string &name)

static bool	hasStackRule (const std::string &name)

static void	registerChangeHook (const std::string &name, ChangeHook fn)

static void	unregisterChangeHook (const std::string &name)

static bool	hasChangeHook (const std::string &name)

static void	ensureBuiltins ()
	确保内置规则已注册（模块首次使用时自动调用）。

static bool	canAdd (Bag bag, const std::string &itemId, int quantity, std::string reason=nullptr)

static int	addItem (Bag *bag, const std::string &itemId, int quantity)
	返回实际放入数量（可能部分成功）。

static int	removeItem (Bag *bag, const std::string &itemId, int quantity)

static int	removeAt (Bag *bag, int slot, int quantity)

static bool	swapSlots (Bag *bag, int slotA, int slotB)

static bool	moveSlot (Bag *bag, int fromSlot, int toSlot)

static bool	splitStack (Bag *bag, int slot, int quantity, int toSlot)

static int	transfer (Bag from, Bag to, const std::string &itemId, int quantity)

static int	transferSlot (Bag from, int fromSlot, Bag to, int quantity)

static int	countItem (const Bag *bag, const std::string &itemId)

static int	findItem (const Bag *bag, const std::string &itemId)

static int	findItemByTag (const Bag *bag, const std::string &tag)

static float	usedWeight (const Bag *bag)

static float	usedVolume (const Bag *bag)

static int	usedSlotCount (const Bag *bag)

static void	clearBag (Bag *bag)

static bool	equipFromBag (EquipmentSet eq, const std::string &equipSlot, Bag bag, int bagSlot)

static bool	unequipToBag (EquipmentSet eq, const std::string &equipSlot, Bag bag)

static void	pushEvent (InventoryChangeEvent ev)

static void	pollEvents (std::vector< InventoryChangeEvent > &out)

static void	clearEvents ()

static const std::vector< InventoryChangeEvent > &	events ()

static int	nextInstanceId ()

详细描述

在文件 InventorySystem.h 第 19 行定义.

成员类型定义说明

◆ AcceptFn

using eve::inventory::InventorySystem::AcceptFn = std::function<bool(const Bag &bag, const ItemDefinition &def, int quantity, std::string *reason)>

在文件 InventorySystem.h 第 21 行定义.

◆ CapacityFn

using eve::inventory::InventorySystem::CapacityFn = std::function<bool(const Bag &bag, const ItemDefinition &def, int quantity, std::string *reason)>

在文件 InventorySystem.h 第 23 行定义.

◆ ChangeHook

using eve::inventory::InventorySystem::ChangeHook = std::function<void(const InventoryChangeEvent &ev)>

在文件 InventorySystem.h 第 27 行定义.

◆ StackFn

using eve::inventory::InventorySystem::StackFn = std::function<bool(const ItemStack &a, const ItemStack &b, const ItemDefinition &def)>

在文件 InventorySystem.h 第 25 行定义.

成员函数说明

◆ addItem()

int eve::inventory::InventorySystem::addItem	(	Bag *	bag,
		const std::string &	itemId,
		int	quantity
	)

static

返回实际放入数量（可能部分成功）。

在文件 InventorySystem.cpp 第 288 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::ItemRegistry::find(), eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::ItemDefinition::id, eve::inventory::InventoryChangeEvent::itemId, nextInstanceId(), eve::inventory::InventoryChangeEvent::quantity, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::addItem(), transfer(), transferSlot() , 以及 unequipToBag().

◆ canAdd()

bool eve::inventory::InventorySystem::canAdd	(	Bag *	bag,
		const std::string &	itemId,
		int	quantity,
		std::string *	reason = `nullptr`
	)

static

在文件 InventorySystem.cpp 第 272 行定义.

引用了 eve::inventory::ItemRegistry::find().

被这些函数引用 eve::inventory::Bag::canAddItem(), eve::inventory::Bag::canAddItemReason(), transfer(), transferSlot() , 以及 unequipToBag().

◆ clearBag()

void eve::inventory::InventorySystem::clearBag ( Bag * bag )

static

在文件 InventorySystem.cpp 第 674 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::Bag::getId(), eve::inventory::InventoryChangeEvent::quantity, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::clear().

◆ clearEvents()

void eve::inventory::InventorySystem::clearEvents ( )

static

在文件 InventorySystem.cpp 第 214 行定义.

被这些函数引用 eve::inventory::Inventory::clearChangeEvents().

◆ countItem()

int eve::inventory::InventorySystem::countItem	(	const Bag *	bag,
		const std::string &	itemId
	)

static

在文件 InventorySystem.cpp 第 613 行定义.

引用了 n, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::countItem() , 以及 transfer().

◆ ensureBuiltins()

void eve::inventory::InventorySystem::ensureBuiltins ( )

static

确保内置规则已注册（模块首次使用时自动调用）。

在文件 InventorySystem.cpp 第 111 行定义.

引用了 a, eve::inventory::Bag::acceptTags(), b, eve::inventory::Bag::getMaxVolume(), eve::inventory::Bag::getMaxWeight(), eve::inventory::Bag::getSlotCount(), registerAcceptRule(), registerCapacityPolicy(), registerStackRule(), eve::inventory::Bag::rejectTags(), eve::inventory::ItemDefinition::tags, usedVolume(), usedWeight(), eve::inventory::ItemDefinition::volume , 以及 eve::inventory::ItemDefinition::weight.

被这些函数引用 hasAcceptRule(), hasCapacityPolicy(), hasStackRule(), eve::inventory::Inventory::newBag(), eve::inventory::Inventory::newEquipmentSet() , 以及 eve::inventory::Inventory::registerItemsFromJson().

◆ equipFromBag()

bool eve::inventory::InventorySystem::equipFromBag	(	EquipmentSet *	eq,
		const std::string &	equipSlot,
		Bag *	bag,
		int	bagSlot
	)

static

在文件 InventorySystem.cpp 第 684 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::EquipmentSet::canEquipFromBag(), eve::inventory::ItemStack::clear(), eve::inventory::InventoryChangeEvent::equipSlot, eve::inventory::Bag::getId(), eve::inventory::InventoryChangeEvent::itemId, eve::inventory::InventoryChangeEvent::quantity, eve::inventory::InventoryChangeEvent::slot, eve::inventory::Bag::slots() , 以及 eve::inventory::EquipmentSet::stackAt().

被这些函数引用 eve::inventory::EquipmentSet::equipFromBag().

◆ events()

const std::vector< InventoryChangeEvent > & eve::inventory::InventorySystem::events ( )

static

在文件 InventorySystem.cpp 第 216 行定义.

被这些函数引用 eve::inventory::Inventory::getChangeEventAction(), eve::inventory::Inventory::getChangeEventBagId(), eve::inventory::Inventory::getChangeEventCount(), eve::inventory::Inventory::getChangeEventEquipSlot(), eve::inventory::Inventory::getChangeEventItemId(), eve::inventory::Inventory::getChangeEventOtherBagId(), eve::inventory::Inventory::getChangeEventOtherSlot(), eve::inventory::Inventory::getChangeEventQuantity() , 以及 eve::inventory::Inventory::getChangeEventSlot().

◆ findItem()

int eve::inventory::InventorySystem::findItem	(	const Bag *	bag,
		const std::string &	itemId
	)

static

在文件 InventorySystem.cpp 第 622 行定义.

引用了 eve::inventory::Bag::getSlotCount(), s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::findItem().

◆ findItemByTag()

int eve::inventory::InventorySystem::findItemByTag	(	const Bag *	bag,
		const std::string &	tag
	)

static

在文件 InventorySystem.cpp 第 631 行定义.

引用了 eve::inventory::ItemRegistry::find(), eve::inventory::Bag::getSlotCount(), eve::inventory::ItemDefinition::hasTag(), s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::findItemByTag().

◆ hasAcceptRule()

bool eve::inventory::InventorySystem::hasAcceptRule ( const std::string & name )

static

在文件 InventorySystem.cpp 第 69 行定义.

引用了 ensureBuiltins() , 以及 name.

被这些函数引用 eve::inventory::Inventory::hasAcceptRule().

◆ hasCapacityPolicy()

bool eve::inventory::InventorySystem::hasCapacityPolicy ( const std::string & name )

static

在文件 InventorySystem.cpp 第 83 行定义.

引用了 ensureBuiltins() , 以及 name.

被这些函数引用 eve::inventory::Inventory::hasCapacityPolicy().

◆ hasChangeHook()

bool eve::inventory::InventorySystem::hasChangeHook ( const std::string & name )

static

在文件 InventorySystem.cpp 第 107 行定义.

引用了 name.

◆ hasStackRule()

bool eve::inventory::InventorySystem::hasStackRule ( const std::string & name )

static

在文件 InventorySystem.cpp 第 95 行定义.

引用了 ensureBuiltins() , 以及 name.

被这些函数引用 eve::inventory::Inventory::hasStackRule().

◆ moveSlot()

bool eve::inventory::InventorySystem::moveSlot	(	Bag *	bag,
		int	fromSlot,
		int	toSlot
	)

static

在文件 InventorySystem.cpp 第 406 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::ItemRegistry::find(), eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::itemId, eve::inventory::ItemDefinition::maxStack, eve::inventory::InventoryChangeEvent::otherSlot, eve::inventory::InventoryChangeEvent::quantity, eve::inventory::InventoryChangeEvent::slot, eve::inventory::Bag::slots() , 以及 swapSlots().

被这些函数引用 eve::inventory::Bag::moveSlot().

◆ nextInstanceId()

int eve::inventory::InventorySystem::nextInstanceId ( )

static

在文件 InventorySystem.cpp 第 198 行定义.

被这些函数引用 addItem(), splitStack(), transferSlot() , 以及 unequipToBag().

◆ pollEvents()

void eve::inventory::InventorySystem::pollEvents ( std::vector< InventoryChangeEvent > & out )

static

在文件 InventorySystem.cpp 第 209 行定义.

◆ pushEvent()

void eve::inventory::InventorySystem::pushEvent ( InventoryChangeEvent ev )

static

在文件 InventorySystem.cpp 第 207 行定义.

被这些函数引用 eve::inventory::EquipmentSet::clearSlot().

◆ registerAcceptRule()

void eve::inventory::InventorySystem::registerAcceptRule	(	const std::string &	name,
		AcceptFn	fn
	)

static

在文件 InventorySystem.cpp 第 62 行定义.

引用了 fn , 以及 name.

被这些函数引用 ensureBuiltins().

◆ registerCapacityPolicy()

void eve::inventory::InventorySystem::registerCapacityPolicy	(	const std::string &	name,
		CapacityFn	fn
	)

static

在文件 InventorySystem.cpp 第 74 行定义.

引用了 fn , 以及 name.

被这些函数引用 ensureBuiltins().

◆ registerChangeHook()

void eve::inventory::InventorySystem::registerChangeHook	(	const std::string &	name,
		ChangeHook	fn
	)

static

在文件 InventorySystem.cpp 第 100 行定义.

引用了 fn , 以及 name.

◆ registerStackRule()

void eve::inventory::InventorySystem::registerStackRule	(	const std::string &	name,
		StackFn	fn
	)

static

在文件 InventorySystem.cpp 第 88 行定义.

引用了 fn , 以及 name.

被这些函数引用 ensureBuiltins().

◆ removeAt()

int eve::inventory::InventorySystem::removeAt	(	Bag *	bag,
		int	slot,
		int	quantity
	)

static

在文件 InventorySystem.cpp 第 374 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::itemId, eve::inventory::InventoryChangeEvent::quantity, s, eve::inventory::InventoryChangeEvent::slot , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::removeAt().

◆ removeItem()

int eve::inventory::InventorySystem::removeItem	(	Bag *	bag,
		const std::string &	itemId,
		int	quantity
	)

static

在文件 InventorySystem.cpp 第 350 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::itemId, eve::inventory::InventoryChangeEvent::quantity, removed, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::removeItem().

◆ splitStack()

bool eve::inventory::InventorySystem::splitStack	(	Bag *	bag,
		int	slot,
		int	quantity,
		int	toSlot
	)

static

在文件 InventorySystem.cpp 第 451 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::itemId, nextInstanceId(), eve::inventory::InventoryChangeEvent::otherSlot, eve::inventory::InventoryChangeEvent::quantity, eve::inventory::InventoryChangeEvent::slot , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::splitStack().

◆ swapSlots()

bool eve::inventory::InventorySystem::swapSlots	(	Bag *	bag,
		int	slotA,
		int	slotB
	)

static

在文件 InventorySystem.cpp 第 392 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, eve::inventory::InventoryChangeEvent::bagId, eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::otherSlot, eve::inventory::InventoryChangeEvent::slot , 以及 eve::inventory::Bag::slots().

被这些函数引用 moveSlot() , 以及 eve::inventory::Bag::swapSlots().

◆ transfer()

int eve::inventory::InventorySystem::transfer	(	Bag *	from,
		Bag *	to,
		const std::string &	itemId,
		int	quantity
	)

static

在文件 InventorySystem.cpp 第 476 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, addItem(), eve::inventory::InventoryChangeEvent::bagId, canAdd(), countItem(), eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::InventoryChangeEvent::itemId, n, eve::inventory::InventoryChangeEvent::otherBagId, eve::inventory::InventoryChangeEvent::quantity, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Inventory::transferItem().

◆ transferSlot()

int eve::inventory::InventorySystem::transferSlot	(	Bag *	from,
		int	fromSlot,
		Bag *	to,
		int	quantity
	)

static

◆ unequipToBag()

bool eve::inventory::InventorySystem::unequipToBag	(	EquipmentSet *	eq,
		const std::string &	equipSlot,
		Bag *	bag
	)

static

在文件 InventorySystem.cpp 第 719 行定义.

引用了 eve::inventory::InventoryChangeEvent::action, addItem(), eve::inventory::InventoryChangeEvent::bagId, canAdd(), eve::inventory::InventoryChangeEvent::equipSlot, eve::inventory::Bag::getId(), eve::inventory::Bag::getSlotCount(), eve::inventory::ItemStack::itemId, eve::inventory::InventoryChangeEvent::itemId, nextInstanceId(), eve::inventory::InventoryChangeEvent::quantity, eve::inventory::InventoryChangeEvent::slot, eve::inventory::Bag::slots() , 以及 eve::inventory::EquipmentSet::stackAt().

被这些函数引用 eve::inventory::EquipmentSet::unequipToBag().

◆ unregisterAcceptRule()

void eve::inventory::InventorySystem::unregisterAcceptRule ( const std::string & name )

static

在文件 InventorySystem.cpp 第 67 行定义.

引用了 name.

◆ unregisterCapacityPolicy()

void eve::inventory::InventorySystem::unregisterCapacityPolicy ( const std::string & name )

static

在文件 InventorySystem.cpp 第 79 行定义.

引用了 name.

◆ unregisterChangeHook()

void eve::inventory::InventorySystem::unregisterChangeHook ( const std::string & name )

static

在文件 InventorySystem.cpp 第 105 行定义.

引用了 name.

◆ unregisterStackRule()

void eve::inventory::InventorySystem::unregisterStackRule ( const std::string & name )

static

在文件 InventorySystem.cpp 第 93 行定义.

引用了 name.

◆ usedSlotCount()

int eve::inventory::InventorySystem::usedSlotCount ( const Bag * bag )

static

在文件 InventorySystem.cpp 第 665 行定义.

引用了 n, s , 以及 eve::inventory::Bag::slots().

被这些函数引用 eve::inventory::Bag::getUsedSlotCount().

◆ usedVolume()

float eve::inventory::InventorySystem::usedVolume ( const Bag * bag )

static

在文件 InventorySystem.cpp 第 654 行定义.

引用了 eve::inventory::ItemRegistry::find(), s, eve::inventory::Bag::slots(), v , 以及 eve::inventory::ItemDefinition::volume.

被这些函数引用 ensureBuiltins() , 以及 eve::inventory::Bag::getUsedVolume().

◆ usedWeight()

float eve::inventory::InventorySystem::usedWeight ( const Bag * bag )

static

在文件 InventorySystem.cpp 第 643 行定义.

引用了 eve::inventory::ItemRegistry::find(), s, eve::inventory::Bag::slots(), w , 以及 eve::inventory::ItemDefinition::weight.

被这些函数引用 ensureBuiltins() , 以及 eve::inventory::Bag::getUsedWeight().

该类的文档由以下文件生成:

src/modules/inventory/InventorySystem.h
src/modules/inventory/InventorySystem.cpp