CScreenInventory Class


Overview

Note

The CScreenInventory class handles inventory and item management for items that characters carry and items on the ground

The structure used for this class is CScreenInventory


Quick Reference

Quick Ref

void CScreenInventory::CScreenInventory()

virtual void CScreenInventory::CancelEngine()

void CScreenInventory::CheckItemIdentify(int nSlot)

virtual int CScreenInventory::CheckMouseLButton()

virtual int CScreenInventory::CheckMouseMove()

virtual int CScreenInventory::CheckMouseRButton()

void CScreenInventory::CheckMultiPlayerViewable()

int CScreenInventory::CheckSlotMergable(unsigned long dwSlotId)

virtual int CScreenInventory::CheckSystemKeyCtrl()

void CScreenInventory::ClearPortraitHighlighting()

void CScreenInventory::CopyNote(int nButtonId)

void CScreenInventory::CopySpell(int nButtonId)

void CScreenInventory::DrinkPotion(int nButtonId)

virtual void CScreenInventory::EngineActivated()

virtual void CScreenInventory::EngineDeactivated()

virtual void CScreenInventory::EngineDestroyed()

virtual void CScreenInventory::EngineGameInit()

virtual void CScreenInventory::EngineGameUninit()

virtual void CScreenInventory::EngineInitialized()

long CScreenInventory::FetchGroundPile(short nPortraitId, int bEvenIfDead)

unsigned long CScreenInventory::FindFreePersonalSlot(unsigned long dwFirstId, unsigned long dwLastId)

void CScreenInventory::FlushGroundPiles()

CGameButtonList* CScreenInventory::GetAbilitiesList(int nButtonId)

CString CScreenInventory::GetButtonString(int nButtonId)

int CScreenInventory::GetCurrentGroundPage()

int CScreenInventory::GetMaxGroundPage()

virtual short CScreenInventory::GetNumVirtualKeys()

int CScreenInventory::GetPersonalSlotHighlight(int nButtonId)

int CScreenInventory::GetScrollIdentifyEnabled(int nButtonId)

int CScreenInventory::GetSlotHighlight(int nButtonId)

unsigned long CScreenInventory::GetSlotIdForTempItem()

int CScreenInventory::GetSpellIdentifyEnabled(int nButtonId)

int CScreenInventory::GetUseButtonMode(int nButtonId)

CString CScreenInventory::GetUseButtonText(int nButtonId, int nMode)

virtual CKeyInfo* CScreenInventory::GetVirtualKeys()

virtual int* CScreenInventory::GetVirtualKeysFlags()

int CScreenInventory::GetWeaponSlotHighlight(int nButtonId)

void CScreenInventory::IdentifyWithScroll(int nButtonId)

void CScreenInventory::IdentifyWithSpell(int nButtonId)

int CScreenInventory::IsAbilitiesButtonActive(int nButtonId)

int CScreenInventory::IsCharacterInRange(int nPortraitNum)

int CScreenInventory::IsSlotValid(unsigned long dwSlotId)

int CScreenInventory::IsSpriteOrderable()

int CScreenInventory::IsUseButtonActive(int nButtonId, int nButtonMode)

int CScreenInventory::MapButtonIdToInventoryId(int nButtonId)

void CScreenInventory::MapButtonIdToItemInfo(int nButtonId, CItem*& pItem, unsigned long& strDesc, CResRef& cResIcon, CResRef& cResItem, unsigned short& wCount)

void CScreenInventory::OnGroundPage(int nPages)

virtual void CScreenInventory::OnKeyDown(int nKeysFlags)

virtual void CScreenInventory::OnLButtonDblClk(CPoint cPoint)

virtual void CScreenInventory::OnLButtonDown(CPoint cPoint)

virtual void CScreenInventory::OnLButtonUp(CPoint cPoint)

virtual void CScreenInventory::OnPortraitLClick(unsigned long id)

virtual void CScreenInventory::OnMouseMove(CPoint cPoint)

virtual void CScreenInventory::OnRButtonDown(CPoint cPoint)

virtual void CScreenInventory::OnRButtonUp(CPoint cPoint)

virtual void CScreenInventory::OnRestButtonClick()

void CScreenInventory::OnUseButtonClick(int nButtonId, int nButtonMode)

void CScreenInventory::PlaySwapSound(CItem* pOldItem, CItem* pNewItem)

void CScreenInventory::RenderEncumbrance(CPoint pos, CRect rClip)

void CScreenInventory::ResetGroundPile()

void CScreenInventory::SelectItemAbility(int nAbility, int nItem, int nButtonId)

void CScreenInventory::SetErrorString(const unsigned long strError, const unsigned long crColor)

virtual void CScreenInventory::SetSystemKeyCtrl(unsigned char bValue)

int CScreenInventory::SwapWithPortrait(int nButtonId, int bShowError)

int CScreenInventory::SwapWithSlot(int nButtonId, int bShowError, unsigned short wCount, int bAutoStacking)

virtual void CScreenInventory::TimerAsynchronousUpdate()

virtual void CScreenInventory::TimerSynchronousUpdate()

void CScreenInventory::UnPauseGame()

virtual void CScreenInventory::UpdateContainerStatus(long nContainerId, short nSlotNum)

void CScreenInventory::UpdateLua()

virtual void CScreenInventory::UpdatePersonalItemStatus(long nSpriteId)


Constructors

Name

Description

CScreenInventory::CScreenInventory

Constructs a CScreenInventory object

CScreenInventory::CScreenInventory

Constructs a CScreenInventory object

void CScreenInventory::CScreenInventory();

Remarks

Constructs a CScreenInventory object


Methods

Name

Description

CScreenInventory::CancelEngine

CScreenInventory::CheckItemIdentify

CScreenInventory::CheckMouseLButton

CScreenInventory::CheckMouseMove

CScreenInventory::CheckMouseRButton

CScreenInventory::CheckMultiPlayerViewable

CScreenInventory::CheckSlotMergable

CScreenInventory::CheckSystemKeyCtrl

CScreenInventory::ClearPortraitHighlighting

CScreenInventory::CopyNote

CScreenInventory::CopySpell

CScreenInventory::DrinkPotion

CScreenInventory::EngineActivated

CScreenInventory::EngineDeactivated

CScreenInventory::EngineDestroyed

CScreenInventory::EngineGameInit

CScreenInventory::EngineGameUninit

CScreenInventory::EngineInitialized

CScreenInventory::FetchGroundPile

CScreenInventory::FindFreePersonalSlot

CScreenInventory::FlushGroundPiles

CScreenInventory::GetAbilitiesList

CScreenInventory::GetButtonString

CScreenInventory::GetCurrentGroundPage

CScreenInventory::GetMaxGroundPage

CScreenInventory::GetNumVirtualKeys

CScreenInventory::GetPersonalSlotHighlight

CScreenInventory::GetScrollIdentifyEnabled

CScreenInventory::GetSlotHighlight

CScreenInventory::GetSlotIdForTempItem

CScreenInventory::GetSpellIdentifyEnabled

CScreenInventory::GetUseButtonMode

CScreenInventory::GetUseButtonText

CScreenInventory::GetVirtualKeys

CScreenInventory::GetVirtualKeysFlags

CScreenInventory::GetWeaponSlotHighlight

CScreenInventory::IdentifyWithScroll

CScreenInventory::IdentifyWithSpell

CScreenInventory::IsAbilitiesButtonActive

CScreenInventory::IsCharacterInRange

CScreenInventory::IsSlotValid

CScreenInventory::IsSpriteOrderable

CScreenInventory::IsUseButtonActive

CScreenInventory::MapButtonIdToInventoryId

CScreenInventory::MapButtonIdToItemInfo

CScreenInventory::OnGroundPage

CScreenInventory::OnKeyDown

CScreenInventory::OnLButtonDblClk

CScreenInventory::OnLButtonDown

CScreenInventory::OnLButtonUp

CScreenInventory::OnPortraitLClick

CScreenInventory::OnMouseMove

CScreenInventory::OnRButtonDown

CScreenInventory::OnRButtonUp

CScreenInventory::OnRestButtonClick

CScreenInventory::OnUseButtonClick

CScreenInventory::PlaySwapSound

CScreenInventory::RenderEncumbrance

CScreenInventory::ResetGroundPile

CScreenInventory::SelectItemAbility

CScreenInventory::SetErrorString

CScreenInventory::SetSystemKeyCtrl

CScreenInventory::SwapWithPortrait

CScreenInventory::SwapWithSlot

CScreenInventory::TimerAsynchronousUpdate

CScreenInventory::TimerSynchronousUpdate

CScreenInventory::UnPauseGame

CScreenInventory::UpdateContainerStatus

CScreenInventory::UpdateLua

CScreenInventory::UpdatePersonalItemStatus


CScreenInventory::CancelEngine

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckItemIdentify

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckMouseLButton

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckMouseMove

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckMouseRButton

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckMultiPlayerViewable

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckSlotMergable

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CheckSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::ClearPortraitHighlighting

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CopyNote

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::CopySpell

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::DrinkPotion

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineActivated

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineDeactivated

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineDestroyed

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineGameInit

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineGameUninit

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::EngineInitialized

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::FetchGroundPile

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::FindFreePersonalSlot

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::FlushGroundPiles

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetAbilitiesList

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetButtonString

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetCurrentGroundPage

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetMaxGroundPage

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetNumVirtualKeys

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetPersonalSlotHighlight

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetScrollIdentifyEnabled

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetSlotHighlight

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetSlotIdForTempItem

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetSpellIdentifyEnabled

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetUseButtonMode

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetUseButtonText

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetVirtualKeys

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetVirtualKeysFlags

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::GetWeaponSlotHighlight

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IdentifyWithScroll

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IdentifyWithSpell

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IsAbilitiesButtonActive

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IsCharacterInRange

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IsSlotValid

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IsSpriteOrderable

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::IsUseButtonActive

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::MapButtonIdToInventoryId

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::MapButtonIdToItemInfo

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnGroundPage

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnKeyDown

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnLButtonDblClk

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnLButtonDown

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnLButtonUp

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnPortraitLClick

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnMouseMove

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnRButtonDown

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnRButtonUp

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnRestButtonClick

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::OnUseButtonClick

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::PlaySwapSound

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::RenderEncumbrance

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::ResetGroundPile

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::SelectItemAbility

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::SetErrorString

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::SetSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::SwapWithPortrait

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::SwapWithSlot

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::TimerAsynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::TimerSynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::UnPauseGame

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::UpdateContainerStatus

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::UpdateLua

x;

Parameters

Return Value

Returns

Remarks


CScreenInventory::UpdatePersonalItemStatus

x;

Parameters

Return Value

Returns

Remarks