GUI.Inventory.IconBox

GUI.Inventory.IconBox
Summary
GUI.Inventory.IconBox
Variables
EXPAND_ITEM_BUTTON_SPACE
BOTTOM_BAR_HEIGHT
VISIBILITY_OFF
VISIBILITY_ON
VISIBILITY_PARTIAL
WINDOW_CORNER_RADIUS
m_Visible
m_WindowMC
m_Grid
m_BottomBar
m_BoxID
m_IconSize
m_IconPaddingX
m_IconPaddingY
m_BoxPadding
m_BottomBarHeight
m_TopBarHeight
m_CanRename
m_BoxHeight
m_BoxWidth
m_NumRows
m_NumColumns
m_NumItems
m_MinNumRows
m_MinNumColumns
m_Name
m_IsPinned
m_IsGlowing
m_HasGrid
m_HasBottomBar
m_WindowHasFullVisibility
m_PinnedBackgroundOpacity
m_LockPositionWhenPinned
m_ItemSlots
m_InventoryId
SignalStartDragging
SignalDeleteItem
SignalUseItem
SignalStartDragItem
SignalStartSplitItem
SignalMouseDownItem
SignalMouseUpItem
SignalMouseUpEmptySlot
SignalMouseDownEmptySlot
Functions
IconBox
SlotBackgroundPressed
SlotBackgroundReleased
SlotMouseDownEmptySlot
SlotMouseUpEmptySlot
SlotStartDrag
SlotTopPressed
SlotMouseOverButton
SlotMouseOutButton
CloseAllTooltips
SlotPinPress
GetWindowMC
GetNumItems
GetName
SetName
SetNumTotalItems
IsPinned
SetPinned
IsGlowing
SetGlowing
IsVisible
GetNumColumns
GetNumRows
GetNumSlots
CalculateSlotPosX
CalculateSlotPosY
RelayoutSlots
GetGridPositionAt
GetFirstFreeGridPosition
GetItemAtGridPosition
IsValidGridPosition
GetItemAt
HitTest
HitTestTopBar
GetBoxID
GetWidth
GetHeight
SetPos
GetPos
GetHorizontalSizeOfSlots
GetVerticalSizeOfSlots
GetNumHorizontalSlotsFromSize
GetNumVerticalSlotsFromSize
UpdateBoxContents
UpdatePinnedBoxContentswrites the box only if the state is pinned and the inventory is hidden.
UpdateDropShadow
SetOnScreenVisibility
UpdateVisibility
SetWindowHasFullVisibility
RemoveItem
ChangeItem
AddShortcutLabelAndAnimation
RemoveShortcutLabelAndAnimation
GetMovieClipFromInventoryPosition
GetGridPositionFromSlotID
AnimateShortcut
ResizeBox
ResizeBoxTo
UpdateItemSlotsArray
GetHighestSlotUsed
CreateEmptySlot
DrawGrid
RemoveGrid
HasGrid
RedrawGrid
CanRename
SlotRenameBoxwhen clicking the title of the inventory, the rename variable is set to true for a second if a user clicks again while the rename variable is true, it will enable them to edit the text
StartWritingName
SlotNameEnterFrame
SlotMouseDownEndWritingName
EndWritingName
onKeyDown
GetInventoryID
GetIconSize
GetIconPaddingX
GetIconPadingY
GetBoxPadding
GetTopBarHeight
GetBottomBarHeight
SetHasBottomBar
GetHasBottomBar
SetPinnedBackgroundOpacity
SetLockPositionWhenPinned

Variables

EXPAND_ITEM_BUTTON_SPACE

public static var EXPAND_ITEM_BUTTON_SPACE: Number

BOTTOM_BAR_HEIGHT

private static var BOTTOM_BAR_HEIGHT: Number

VISIBILITY_OFF

private static var VISIBILITY_OFF: Number

VISIBILITY_ON

private static var VISIBILITY_ON: Number

VISIBILITY_PARTIAL

private static var VISIBILITY_PARTIAL: Number

WINDOW_CORNER_RADIUS

private static var WINDOW_CORNER_RADIUS: Number

m_Visible

private var m_Visible: Boolean

m_WindowMC

private var m_WindowMC: MovieClip

m_Grid

private var m_Grid: MovieClip

m_BottomBar

private var m_BottomBar: MovieClip

m_BoxID

private var m_BoxID: Number

m_IconSize

private var m_IconSize: Number

m_IconPaddingX

private var m_IconPaddingX: Number

m_IconPaddingY

private var m_IconPaddingY: Number

m_BoxPadding

private var m_BoxPadding: Rect

m_BottomBarHeight

private var m_BottomBarHeight: Number

m_TopBarHeight

private var m_TopBarHeight: Number

m_CanRename

private var m_CanRename: Boolean

m_BoxHeight

private var m_BoxHeight

m_BoxWidth

private var m_BoxWidth

m_NumRows

private var m_NumRows

m_NumColumns

private var m_NumColumns

m_NumItems

private var m_NumItems

m_MinNumRows

private var m_MinNumRows: Number

m_MinNumColumns

private var m_MinNumColumns: Number

m_Name

private var m_Name: String

m_IsPinned

private var m_IsPinned: Boolean

m_IsGlowing

private var m_IsGlowing: Boolean

m_HasGrid

private var m_HasGrid: Boolean

m_HasBottomBar

private var m_HasBottomBar: Boolean

m_WindowHasFullVisibility

private var m_WindowHasFullVisibility: Boolean

m_PinnedBackgroundOpacity

private var m_PinnedBackgroundOpacity: Number

m_LockPositionWhenPinned

private var m_LockPositionWhenPinned: Boolean

m_ItemSlots

private var m_ItemSlots: Array

m_InventoryId

private var m_InventoryId: ID32

SignalStartDragging

public var SignalStartDragging: Signal

SignalDeleteItem

public var SignalDeleteItem: Signal

SignalUseItem

public var SignalUseItem: Signal

SignalStartDragItem

public var SignalStartDragItem: Signal

SignalStartSplitItem

public var SignalStartSplitItem: Signal

SignalMouseDownItem

public var SignalMouseDownItem: Signal

SignalMouseUpItem

public var SignalMouseUpItem: Signal

SignalMouseUpEmptySlot

public var SignalMouseUpEmptySlot: Signal

SignalMouseDownEmptySlot

public var SignalMouseDownEmptySlot: Signal

Functions

IconBox

public function IconBox(boxID: Number,
inventoryId: ID32,
windowMC: MovieClip,
numRows: Number,
numColumns: Number)

SlotBackgroundPressed

private function SlotBackgroundPressed(buttonIdx: Number)

SlotBackgroundReleased

private function SlotBackgroundReleased(buttonIdx: Number)

SlotMouseDownEmptySlot

private function SlotMouseDownEmptySlot(gridPos: Point,
buttonIdx: Number)

SlotMouseUpEmptySlot

private function SlotMouseUpEmptySlot(gridPos: Point,
buttonIdx: Number)

SlotStartDrag

private function SlotStartDrag()

SlotTopPressed

private function SlotTopPressed()

SlotMouseOverButton

private function SlotMouseOverButton()

SlotMouseOutButton

private function SlotMouseOutButton()

CloseAllTooltips

public function CloseAllTooltips()

SlotPinPress

private function SlotPinPress()

GetWindowMC

public function GetWindowMC():MovieClip

GetNumItems

public function GetNumItems():Number

GetName

public function GetName():String

SetName

public function SetName(name: String)

SetNumTotalItems

public function SetNumTotalItems(numItems: Number,
numMaxItems: Number)

IsPinned

public function IsPinned():Boolean

SetPinned

public function SetPinned(pin: Boolean)

IsGlowing

public function IsGlowing():Boolean

SetGlowing

public function SetGlowing(glow: Boolean)

IsVisible

public function IsVisible():Boolean

GetNumColumns

public function GetNumColumns():Number

GetNumRows

public function GetNumRows():Number

GetNumSlots

public function GetNumSlots()

CalculateSlotPosX

private function CalculateSlotPosX(val: Number)

CalculateSlotPosY

private function CalculateSlotPosY(val: Number)

RelayoutSlots

public function RelayoutSlots()

GetGridPositionAt

public function GetGridPositionAt(x: Number,
y: Number):Point

GetFirstFreeGridPosition

public function GetFirstFreeGridPosition()

GetItemAtGridPosition

public function GetItemAtGridPosition(gridPos: Point)

IsValidGridPosition

public function IsValidGridPosition(gridPos: Point) : Boolean

GetItemAt

public function GetItemAt(dstX: Number,
dstY: Number):ItemSlot

HitTest

public function HitTest(x: Number,
y: Number)

HitTestTopBar

public function HitTestTopBar(x: Number,
y: Number)

GetBoxID

public function GetBoxID() :Number

GetWidth

public function GetWidth()

GetHeight

public function GetHeight()

SetPos

public function SetPos(x: Number,
y: Number)

GetPos

public function GetPos():Point

GetHorizontalSizeOfSlots

function GetHorizontalSizeOfSlots(numSlots: Number)

GetVerticalSizeOfSlots

function GetVerticalSizeOfSlots(numSlots: Number)

GetNumHorizontalSlotsFromSize

function GetNumHorizontalSlotsFromSize(width: Number)

GetNumVerticalSlotsFromSize

function GetNumVerticalSlotsFromSize(width: Number)

UpdateBoxContents

private function UpdateBoxContents(width: Number,
height: Number)

UpdatePinnedBoxContents

private function UpdatePinnedBoxContents(width: Number,
height: Number) : Void

writes the box only if the state is pinned and the inventory is hidden.  The box is only the frame around the icons

Parameters

width:Number - witdh of the box to draw
height:Number - height of the box to draw

Returns

Void

UpdateDropShadow

private function UpdateDropShadow(displayingAsPinned: Boolean):Void

SetOnScreenVisibility

public function SetOnScreenVisibility(stateVisible: Boolean)

UpdateVisibility

private function UpdateVisibility()

SetWindowHasFullVisibility

private function SetWindowHasFullVisibility(fullVisibility: Boolean)

RemoveItem

public function RemoveItem(itemID: Number):Boolean

ChangeItem

public function ChangeItem(itemID: Number,
itemData: Object)

AddShortcutLabelAndAnimation

public function AddShortcutLabelAndAnimation(inventoryPosition: Number,
label: String):Void

RemoveShortcutLabelAndAnimation

public function RemoveShortcutLabelAndAnimation(inventoryPosition: Number):Void

GetMovieClipFromInventoryPosition

public function GetMovieClipFromInventoryPosition(
   inventoryPosition: Number
):MovieClip

GetGridPositionFromSlotID

public function GetGridPositionFromSlotID(itemID: Number):Point

AnimateShortcut

public function AnimateShortcut(inventoryPosition: Number):Void

ResizeBox

private function ResizeBox(isDefaultWindow: Boolean)

ResizeBoxTo

public function ResizeBoxTo(numRows: Number,
numColumns: Number,
isDefaultWindow: Boolean)

UpdateItemSlotsArray

public function UpdateItemSlotsArray(numRows: Number,
numColumns: Number)

GetHighestSlotUsed

public function GetHighestSlotUsed():Point

CreateEmptySlot

public function CreateEmptySlot(gridPosition: Point,
slotID: Number)

DrawGrid

public function DrawGrid(isDefaultWindow: Boolean):Void

RemoveGrid

public function RemoveGrid()

HasGrid

public function HasGrid():Boolean

RedrawGrid

public function RedrawGrid(isDefaultWindow: Boolean)

CanRename

public function CanRename(value: Boolean):Void

SlotRenameBox

private function SlotRenameBox(buttonIndex: Number,
clickCount: Number)

when clicking the title of the inventory, the rename variable is set to true for a second if a user clicks again while the rename variable is true, it will enable them to edit the text

StartWritingName

public function StartWritingName()

SlotNameEnterFrame

public function SlotNameEnterFrame()

SlotMouseDownEndWritingName

public function SlotMouseDownEndWritingName()

EndWritingName

public function EndWritingName()

onKeyDown

public function onKeyDown()

GetInventoryID

public function GetInventoryID():ID32

GetIconSize

public function GetIconSize():Number

GetIconPaddingX

public function GetIconPaddingX():Number

GetIconPadingY

public function GetIconPadingY():Number

GetBoxPadding

public function GetBoxPadding():Rect

GetTopBarHeight

public function GetTopBarHeight():Number

GetBottomBarHeight

public function GetBottomBarHeight():Number

SetHasBottomBar

public function SetHasBottomBar(value: Boolean):Void

GetHasBottomBar

public function GetHasBottomBar():Boolean

SetPinnedBackgroundOpacity

public function SetPinnedBackgroundOpacity(value: Number):Void

SetLockPositionWhenPinned

public function SetLockPositionWhenPinned(value: Boolean):Void
public static var EXPAND_ITEM_BUTTON_SPACE: Number
private static var BOTTOM_BAR_HEIGHT: Number
private static var VISIBILITY_OFF: Number
private static var VISIBILITY_ON: Number
private static var VISIBILITY_PARTIAL: Number
private static var WINDOW_CORNER_RADIUS: Number
private var m_Visible: Boolean
private var m_WindowMC: MovieClip
private var m_Grid: MovieClip
private var m_BottomBar: MovieClip
private var m_BoxID: Number
private var m_IconSize: Number
private var m_IconPaddingX: Number
private var m_IconPaddingY: Number
private var m_BoxPadding: Rect
private var m_BottomBarHeight: Number
private var m_TopBarHeight: Number
private var m_CanRename: Boolean
private var m_BoxHeight
private var m_BoxWidth
private var m_NumRows
private var m_NumColumns
private var m_NumItems
private var m_MinNumRows: Number
private var m_MinNumColumns: Number
private var m_Name: String
private var m_IsPinned: Boolean
private var m_IsGlowing: Boolean
private var m_HasGrid: Boolean
private var m_HasBottomBar: Boolean
private var m_WindowHasFullVisibility: Boolean
private var m_PinnedBackgroundOpacity: Number
private var m_LockPositionWhenPinned: Boolean
private var m_ItemSlots: Array
private var m_InventoryId: ID32
public var SignalStartDragging: Signal
public var SignalDeleteItem: Signal
public var SignalUseItem: Signal
public var SignalStartDragItem: Signal
public var SignalStartSplitItem: Signal
public var SignalMouseDownItem: Signal
public var SignalMouseUpItem: Signal
public var SignalMouseUpEmptySlot: Signal
public var SignalMouseDownEmptySlot: Signal
public function IconBox(boxID: Number,
inventoryId: ID32,
windowMC: MovieClip,
numRows: Number,
numColumns: Number)
private function SlotBackgroundPressed(buttonIdx: Number)
private function SlotBackgroundReleased(buttonIdx: Number)
private function SlotMouseDownEmptySlot(gridPos: Point,
buttonIdx: Number)
private function SlotMouseUpEmptySlot(gridPos: Point,
buttonIdx: Number)
private function SlotStartDrag()
private function SlotTopPressed()
private function SlotMouseOverButton()
private function SlotMouseOutButton()
public function CloseAllTooltips()
private function SlotPinPress()
public function GetWindowMC():MovieClip
public function GetNumItems():Number
public function GetName():String
public function SetName(name: String)
public function SetNumTotalItems(numItems: Number,
numMaxItems: Number)
public function IsPinned():Boolean
public function SetPinned(pin: Boolean)
public function IsGlowing():Boolean
public function SetGlowing(glow: Boolean)
public function IsVisible():Boolean
public function GetNumColumns():Number
public function GetNumRows():Number
public function GetNumSlots()
private function CalculateSlotPosX(val: Number)
private function CalculateSlotPosY(val: Number)
public function RelayoutSlots()
public function GetGridPositionAt(x: Number,
y: Number):Point
public function GetFirstFreeGridPosition()
public function GetItemAtGridPosition(gridPos: Point)
public function IsValidGridPosition(gridPos: Point) : Boolean
public function GetItemAt(dstX: Number,
dstY: Number):ItemSlot
public function HitTest(x: Number,
y: Number)
public function HitTestTopBar(x: Number,
y: Number)
public function GetBoxID() :Number
public function GetWidth()
public function GetHeight()
public function SetPos(x: Number,
y: Number)
public function GetPos():Point
function GetHorizontalSizeOfSlots(numSlots: Number)
function GetVerticalSizeOfSlots(numSlots: Number)
function GetNumHorizontalSlotsFromSize(width: Number)
function GetNumVerticalSlotsFromSize(width: Number)
private function UpdateBoxContents(width: Number,
height: Number)
private function UpdatePinnedBoxContents(width: Number,
height: Number) : Void
writes the box only if the state is pinned and the inventory is hidden.
private function UpdateDropShadow(displayingAsPinned: Boolean):Void
public function SetOnScreenVisibility(stateVisible: Boolean)
private function UpdateVisibility()
private function SetWindowHasFullVisibility(fullVisibility: Boolean)
public function RemoveItem(itemID: Number):Boolean
public function ChangeItem(itemID: Number,
itemData: Object)
public function AddShortcutLabelAndAnimation(inventoryPosition: Number,
label: String):Void
public function RemoveShortcutLabelAndAnimation(inventoryPosition: Number):Void
public function GetMovieClipFromInventoryPosition(
   inventoryPosition: Number
):MovieClip
public function GetGridPositionFromSlotID(itemID: Number):Point
public function AnimateShortcut(inventoryPosition: Number):Void
private function ResizeBox(isDefaultWindow: Boolean)
public function ResizeBoxTo(numRows: Number,
numColumns: Number,
isDefaultWindow: Boolean)
public function UpdateItemSlotsArray(numRows: Number,
numColumns: Number)
public function GetHighestSlotUsed():Point
public function CreateEmptySlot(gridPosition: Point,
slotID: Number)
public function DrawGrid(isDefaultWindow: Boolean):Void
public function RemoveGrid()
public function HasGrid():Boolean
public function RedrawGrid(isDefaultWindow: Boolean)
public function CanRename(value: Boolean):Void
private function SlotRenameBox(buttonIndex: Number,
clickCount: Number)
when clicking the title of the inventory, the rename variable is set to true for a second if a user clicks again while the rename variable is true, it will enable them to edit the text
public function StartWritingName()
public function SlotNameEnterFrame()
public function SlotMouseDownEndWritingName()
public function EndWritingName()
public function onKeyDown()
public function GetInventoryID():ID32
public function GetIconSize():Number
public function GetIconPaddingX():Number
public function GetIconPadingY():Number
public function GetBoxPadding():Rect
public function GetTopBarHeight():Number
public function GetBottomBarHeight():Number
public function SetHasBottomBar(value: Boolean):Void
public function GetHasBottomBar():Boolean
public function SetPinnedBackgroundOpacity(value: Number):Void
public function SetLockPositionWhenPinned(value: Boolean):Void
Close