com.GameInterface.Game.Shortcut

Summary
com.GameInterface.Game.Shortcut
Variables
m_ShortcutListAssociavite array of all the shortcut the player has
Functions
RefreshShortcutsForces the client to send add or remove signal for each of the slots in the range.
MoveShortcutTry to move a shortcut to a new pos.
RemoveFromShortcutBarTry to remove a shortcut.
RemoveAugmentTry to remove an augment SignalShortcutRemoved will be triggered if the remove was legal.
UseShortcutTry to use a shortcut.
AddSpellAdd a spell to a slot.
AddAugmentAdd an augment to a slot.
AddItemAdd an item to a slot.
GetNumPocketSlotsGets the number of usable pocket slots
GetMaxPocketSlotsGets the max number of pocket slots
IsSpellEquipped
Variables
SignalShortcutAddedSignal sent when a shortcut has been added.
SignalShortcutRemovedSignal sent when a shortcut has been removed.
SignalShortcutMovedSignal sent when a shortcut has been move to some other spot.
SignalHotkeyChangedSignal sent when a hotkey is changed
SignalShortcutStatChangedSignal sent when a shortcut changed one of it’s stats.
SignalShortcutEnabledSignal sent when a shortcut is enabled/disabled.
SignalShortcutRangeEnabledSignal sent when a shortcut is enabled/disabled via range.
SignalShortcutUsedSignal sent when a shortcut is used
SignalShortcutAddedToQueueSignal sent when a shortcut is added to the queue
SignalShortcutRemovedFromQueueSignal sent when a shortcut is removed from the queue
SignalCooldownTimeSignal sent when a shortcut enters cooldown.
SignalShortcutsRefreshSignal sent when the shortcut list has been loaded or when something else has forced it to be refreshed.
SignalSwapShortcutSignal sent when a shortcut enters or exits max momentum (all resources filled up or not).
SignalSwapBar
SignalRestoreSwapBar
SignalNumPocketSlotsChanged

Variables

m_ShortcutList

public static var m_ShortcutList: Object

Associavite array of all the shortcut the player has

Functions

RefreshShortcuts

public static function RefreshShortcuts(fromPos: Number,
count: Number) : Void

Forces the client to send add or remove signal for each of the slots in the range.

Parameters

fromPos:Number The position to start the refersh from.
count:Number Number of positions to refresh.

MoveShortcut

public static function MoveShortcut(fromPos: Number,
toPos: Number) : Void

Try to move a shortcut to a new pos.  If the move was allowed, SignalShortcutMoved will be triggered.

Parameters

fromPos:Number The position to move from.
toPos:Number The position to move to.

RemoveFromShortcutBar

public static function RemoveFromShortcutBar(itemPos: Number) : Boolean

Try to remove a shortcut.  SignalShortcutRemoved will be triggered if the remove was legal.

Parameters

itemPos:Number The shortcut to remove.

RemoveAugment

public static function RemoveAugment(itemPos: Number) : Boolean

Try to remove an augment SignalShortcutRemoved will be triggered if the remove was legal.

Parameters

itemPos:Number The augment to remove.

UseShortcut

public static function UseShortcut(itemPos: Number) : Void

Try to use a shortcut.  You will not know the outcome, but you might get a SignalCooldownTime.

Parameters

itemPos:Number The shortcut to use.

AddSpell

public static function AddSpell(itemPos: Number,
spellId: Number) : Void

Add a spell to a slot.  SignalShortcutAdded will be called on success.

Parameters

itemPos:Number The position on the bar.
spellId:Number The spell to auto add.

AddAugment

public static function AddAugment(itemPos: Number,
spellId: Number) : Void

Add an augment to a slot.  SignalShortcutAdded will be called on success.

Parameters

itemPos:Number The position on the bar.
spellId:Number The spell to auto add.

AddItem

public static function AddItem(shortcutPos: Number,
inventoryId: ID32,
itemPos: Number) : Void

Add an item to a slot.  SignalShortcutAdded will be called on success.

Parameters

shortcutPos:Number The position on the bar.
inventoryId:Number From which inventory its added.
itemPos:Number The itemposition in the inventory to add.

GetNumPocketSlots

public static function GetNumPocketSlots( ) : Number

Gets the number of usable pocket slots

GetMaxPocketSlots

public static function GetMaxPocketSlots( ) : Number

Gets the max number of pocket slots

IsSpellEquipped

public static function IsSpellEquipped(spellId: Number):Boolean

Variables

SignalShortcutAdded

public static var SignalShortcutAdded: Signal

Signal sent when a shortcut has been added.  This also happens when you teleport to a new pf.  Note that you might get an SignalShortcutEnabled right afterward if the shortcut is disabled.  And SignalCooldownTime if it’s in cooldown.

Parameters

itemPos:Number The position the item was added to.  This is used for refering to this item.
name:String The name of the item in LDB format.
icon:String The icon resource information.
itemClass:Number The type of shortcut.  See Enums.StatItemClass

SignalShortcutRemoved

public static var SignalShortcutRemoved: Signal

Signal sent when a shortcut has been removed.  This will not be sent if the shortcut changes position, moved.

Parameters

itemPos:Number The position the item was added to.  This is used for refering to this item.

SignalShortcutMoved

public static var SignalShortcutMoved: Signal

Signal sent when a shortcut has been move to some other spot.  No add/remove signal will be triggered.

Parameters

fromPos:Number The position the item was move from.
toPos:Number The position the item was move to.

SignalHotkeyChanged

public static var SignalHotkeyChanged: Signal

Signal sent when a hotkey is changed

Parameters

hotkeyId:Number ID of the changed hotkey

SignalShortcutStatChanged

public static var SignalShortcutStatChanged: Signal

Signal sent when a shortcut changed one of it’s stats.  Probably most usefull for stacksize changes.

Parameters

itemPos:Number The position of the item.
stat:Number The stat that changed.  See Enums/Stats.as
value:Number The new value for the stat.

SignalShortcutEnabled

public static var SignalShortcutEnabled: Signal

Signal sent when a shortcut is enabled/disabled.  Will also be send when you enter a new playfield.

Parameters

itemPos:Number The position of the item.
enabled:Boolean Enabled/Disabled

SignalShortcutRangeEnabled

public static var SignalShortcutRangeEnabled: Signal

Signal sent when a shortcut is enabled/disabled via range.

Parameters

itemPos:Number The position of the item.
enabled:Boolean Enabled/Disabled

SignalShortcutUsed

public static var SignalShortcutUsed: Signal

Signal sent when a shortcut is used

Parameters

itemPos:Number The position of the item.

SignalShortcutAddedToQueue

public static var SignalShortcutAddedToQueue: Signal

Signal sent when a shortcut is added to the queue

Parameters

itemPos:Number The position of the item.

SignalShortcutRemovedFromQueue

public static var SignalShortcutRemovedFromQueue: Signal

Signal sent when a shortcut is removed from the queue

Parameters

itemPos:Number The position of the item.

SignalCooldownTime

public static var SignalCooldownTime: Signal

Signal sent when a shortcut enters cooldown.  Will also be send when you enter a new playfield.

Parameters

itemPos:Number The position of the item.
seconds:Number The cooldown time in seconds left.
cooddownType:Number The cooldown type from Enums.TemplateLock...

SignalShortcutsRefresh

public static var SignalShortcutsRefresh: Signal

Signal sent when the shortcut list has been loaded or when something else has forced it to be refreshed.  So this will be called on login at least.  Normal response to this call is RefreshShortcuts( fromPos, count )

SignalSwapShortcut

public static var SignalSwapShortcut: Signal

Signal sent when a shortcut enters or exits max momentum (all resources filled up or not).  / @param itemPos:Number The position of the item. public static var SignalShortcutMaxMomentumEnabled:Signal; // -> SlotSignalShortcutMaxMomentumEnabled( itemPos:Number, enabled:Boolean )

SignalSwapBar

public static var SignalSwapBar: Signal

SignalRestoreSwapBar

public static var SignalRestoreSwapBar: Signal

SignalNumPocketSlotsChanged

public static var SignalNumPocketSlotsChanged
public static var m_ShortcutList: Object
Associavite array of all the shortcut the player has
public static function RefreshShortcuts(fromPos: Number,
count: Number) : Void
Forces the client to send add or remove signal for each of the slots in the range.
public static function MoveShortcut(fromPos: Number,
toPos: Number) : Void
Try to move a shortcut to a new pos.
public static function RemoveFromShortcutBar(itemPos: Number) : Boolean
Try to remove a shortcut.
public static function RemoveAugment(itemPos: Number) : Boolean
Try to remove an augment SignalShortcutRemoved will be triggered if the remove was legal.
public static function UseShortcut(itemPos: Number) : Void
Try to use a shortcut.
public static function AddSpell(itemPos: Number,
spellId: Number) : Void
Add a spell to a slot.
public static function AddAugment(itemPos: Number,
spellId: Number) : Void
Add an augment to a slot.
public static function AddItem(shortcutPos: Number,
inventoryId: ID32,
itemPos: Number) : Void
Add an item to a slot.
public static function GetNumPocketSlots( ) : Number
Gets the number of usable pocket slots
public static function GetMaxPocketSlots( ) : Number
Gets the max number of pocket slots
public static function IsSpellEquipped(spellId: Number):Boolean
public static var SignalShortcutAdded: Signal
Signal sent when a shortcut has been added.
public static var SignalShortcutRemoved: Signal
Signal sent when a shortcut has been removed.
public static var SignalShortcutMoved: Signal
Signal sent when a shortcut has been move to some other spot.
public static var SignalHotkeyChanged: Signal
Signal sent when a hotkey is changed
public static var SignalShortcutStatChanged: Signal
Signal sent when a shortcut changed one of it’s stats.
public static var SignalShortcutEnabled: Signal
Signal sent when a shortcut is enabled/disabled.
public static var SignalShortcutRangeEnabled: Signal
Signal sent when a shortcut is enabled/disabled via range.
public static var SignalShortcutUsed: Signal
Signal sent when a shortcut is used
public static var SignalShortcutAddedToQueue: Signal
Signal sent when a shortcut is added to the queue
public static var SignalShortcutRemovedFromQueue: Signal
Signal sent when a shortcut is removed from the queue
public static var SignalCooldownTime: Signal
Signal sent when a shortcut enters cooldown.
public static var SignalShortcutsRefresh: Signal
Signal sent when the shortcut list has been loaded or when something else has forced it to be refreshed.
public static var SignalSwapShortcut: Signal
Signal sent when a shortcut enters or exits max momentum (all resources filled up or not).
public static var SignalSwapBar: Signal
public static var SignalRestoreSwapBar: Signal
public static var SignalNumPocketSlotsChanged
Close