Difference between revisions of "ActionScript:Tooltips"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Initial skeleton. Need to flesh out with more data.)
 
m (Added some info about StartDragging)
Line 10: Line 10:
 
The other GUI files use the [[ActionScript:ExternalCommands|ExternalCommands]] class to send the tooltip text to this class through the game engine.
 
The other GUI files use the [[ActionScript:ExternalCommands|ExternalCommands]] class to send the tooltip text to this class through the game engine.
  
== Points of Interest ==
+
== Class Methods of Interest ==
  
TBD
+
{{asfunction|
 +
|name = StartDragging
 +
|brief = Called by the engine when the player drags on a movable tooltip; of note are the spell and skill icons that can be dropped onto the quickbar. This entry-point of updating the tooltip is special in that the update is not triggered by a change to an observed [[ActionScript:ExternalCommands|ExternalCommands]] attribute, but called externally instead.
 +
|param1name = a_nPosX
 +
|param1desc = The X coordinate at which the mouse drag started.
 +
|param2name = a_nPosY
 +
|param2desc = The Y coordinate at which the mouse drag started.
 +
|returndesc = Nothing
 +
}}
  
 
== Referenced External Attributes ==
 
== Referenced External Attributes ==
Line 47: Line 55:
 
* "GUITooltips.TooltipType"
 
* "GUITooltips.TooltipType"
 
* "Scaleform.Platform"
 
* "Scaleform.Platform"
 
== Class Methods ==
 
TBD
 
  
 
[[Category:ActionScript:Classes]]
 
[[Category:ActionScript:Classes]]

Revision as of 03:19, 16 December 2009

Description

  • GFx file: tooltips.gfx
  • ERF: guiexport.erf

This class is the point of origin for tooltips in the game. They come in many different forms, from the those that popup when you hover over an inventory item, to the draggable spell and skill icons that you can drop onto the quickbar. The Tooltips class is only found in the GFX file tooltips.gfx, contained in the ERF guiexport.erf.

The other GUI files use the ExternalCommands class to send the tooltip text to this class through the game engine.

Class Methods of Interest

Called by the engine when the player drags on a movable tooltip; of note are the spell and skill icons that can be dropped onto the quickbar. This entry-point of updating the tooltip is special in that the update is not triggered by a change to an observed ExternalCommands attribute, but called externally instead.

StartDragging(

a_nPosX,
a_nPosY

);

Parameters:
a_nPosX
The X coordinate at which the mouse drag started.
a_nPosY
The Y coordinate at which the mouse drag started.

Returns:
Nothing


Referenced External Attributes

These strings are used by the ExternalCommands class for intercommunication between the engine and other GUI forms.

  • "DebugOptions.EnableController"
  • "DebugOptions.EnableDebugHelpers"
  • "GameModeController.CurrentGameMode"
  • "GameModeExplore.PendingTargetID"
  • "GameModeExplore.PendingTargetID.IsCreature"
  • "GameModeExplore.PendingTargetID.IsPlaceable"
  • "GameModeExplore.PendingTargetID.PlaceableName"
  • "GameModeExplore.PendingTargetID.PrimaryAction"
  • "GameModeExplore.PendingTargetID.SecondaryAction"
  • "GUI.DragData.DragAbortAttribute"
  • "GUI.DragData.DragImage"
  • "GUI.DragData.OnPickupCallback"
  • "GUI.QuickbarXMax"
  • "GUI.SelectedBookPage"
  • "InputMappings.Mappings.PerformPrimaryAction.PrimaryMappedKey"
  • "InputMappings.Mappings.PerformSecondaryAction.PrimaryMappedKey"
  • "GUITooltips.HostAnchor"
  • "GUITooltips.HostX"
  • "GUITooltips.HostY"
  • "GUITooltips.HostWidth"
  • "GUITooltips.HostHeight"
  • "GUITooltips.MaxTooltipWidth"
  • "GUITooltips.MinTooltipWidth"
  • "GUITooltips.TooltipAnchor"
  • "GUITooltips.TooltipCompare0"
  • "GUITooltips.TooltipCompare1"
  • "GUITooltips.TooltipText"
  • "GUITooltips.TooltipType"
  • "Scaleform.Platform"