#include <W3DInGameUI.h>
Inherits InGameUI.
Public Member Functions | |
| W3DInGameUI () | |
| virtual | ~W3DInGameUI () |
| virtual void | init (void) |
| Initialize the in-game user interface. | |
| virtual void | update (void) |
| virtual void | reset (void) |
| Reset. | |
| virtual void | draw (void) |
| Render the in-game user interface. | |
Public Member Functions inherited from InGameUI | |
| InGameUI (void) | |
| virtual | ~InGameUI (void) |
| virtual void | popupMessage (const AsciiString &message, Int x, Int y, Int width, Bool pause, Bool pauseMusic) |
| virtual void | popupMessage (const AsciiString &message, Int x, Int y, Int width, Color textColor, Bool pause, Bool pauseMusic) |
| PopupMessageData * | getPopupMessageData (void) |
| void | clearPopupMessageData (void) |
| virtual void | messageColor (const RGBColor *rgbColor, UnicodeString format,...) |
| display a colored message to the user | |
| virtual void | message (UnicodeString format,...) |
| display a message to the user | |
| virtual void | message (AsciiString stringManagerLabel,...) |
| display a message to the user | |
| virtual void | toggleMessages (void) |
| toggle messages on/off | |
| virtual Bool | isMessagesOn (void) |
| are the display messages on | |
| void | freeMessageResources (void) |
| free resources for the ui messages | |
| Color | getMessageColor (Bool altColor) |
| virtual void | militarySubtitle (const AsciiString &label, Int duration) |
| virtual void | removeMilitarySubtitle (void) |
| virtual void | displayCantBuildMessage (LegalBuildCode lbc) |
| display message to use as to why they can't build here | |
| virtual void | beginAreaSelectHint (const GameMessage *msg) |
| Used by HintSpy. An area selection is occurring, start graphical "hint". | |
| virtual void | endAreaSelectHint (const GameMessage *msg) |
| Used by HintSpy. An area selection had occurred, finish graphical "hint". | |
| virtual void | createMoveHint (const GameMessage *msg) |
| A move command has occurred, start graphical "hint". | |
| virtual void | createAttackHint (const GameMessage *msg) |
| An attack command has occurred, start graphical "hint". | |
| virtual void | createForceAttackHint (const GameMessage *msg) |
| A force attack command has occurred, start graphical "hint". | |
| virtual void | createMouseoverHint (const GameMessage *msg) |
| An object is mouse hovered over, start hint if any. | |
| virtual void | createCommandHint (const GameMessage *msg) |
| Used by HintSpy. Someone is selected so generate the right Cursor for the potential action. | |
| virtual void | createGarrisonHint (const GameMessage *msg) |
| A garrison command has occurred, start graphical "hint". | |
| virtual void | addSuperweapon (Int playerIndex, const AsciiString &powerName, ObjectID id, const SpecialPowerTemplate *powerTemplate) |
| virtual Bool | removeSuperweapon (Int playerIndex, const AsciiString &powerName, ObjectID id, const SpecialPowerTemplate *powerTemplate) |
| virtual void | objectChangedTeam (const Object *obj, Int oldPlayerIndex, Int newPlayerIndex) |
| virtual void | setSuperweaponDisplayEnabledByScript (Bool enable) |
| Set the superweapon display enabled or disabled. | |
| virtual Bool | getSuperweaponDisplayEnabledByScript (void) const |
| Get the current superweapon display status. | |
| virtual void | hideObjectSuperweaponDisplayByScript (const Object *obj) |
| virtual void | showObjectSuperweaponDisplayByScript (const Object *obj) |
| void | addNamedTimer (const AsciiString &timerName, const UnicodeString &text, Bool isCountdown) |
| void | removeNamedTimer (const AsciiString &timerName) |
| void | showNamedTimerDisplay (Bool show) |
| virtual void | setScrolling (Bool isScrolling) |
| set right-click scroll mode | |
| virtual Bool | isScrolling (void) |
| are we scrolling? | |
| virtual void | setSelecting (Bool isSelecting) |
| set drag select mode | |
| virtual Bool | isSelecting (void) |
| are we selecting? | |
| virtual void | setScrollAmount (Coord2D amt) |
| set scroll amount | |
| virtual Coord2D | getScrollAmount (void) |
| get scroll amount | |
| virtual void | setGUICommand (const CommandButton *command) |
| the command has been clicked in the UI and needs additional data | |
| virtual const CommandButton * | getGUICommand (void) const |
| get the pending gui command | |
| virtual void | placeBuildAvailable (const ThingTemplate *build, Drawable *buildDrawable) |
| built thing being placed | |
| virtual const ThingTemplate * | getPendingPlaceType (void) |
| get item we're trying to place | |
| virtual const ObjectID | getPendingPlaceSourceObjectID (void) |
| get producing object | |
| virtual Bool | getPreventLeftClickDeselectionInAlternateMouseModeForOneClick () const |
| virtual void | setPreventLeftClickDeselectionInAlternateMouseModeForOneClick (Bool set) |
| virtual void | setPlacementStart (const ICoord2D *start) |
| placement anchor point (for choosing angles) | |
| virtual void | setPlacementEnd (const ICoord2D *end) |
| set target placement point (for choosing angles) | |
| virtual Bool | isPlacementAnchored (void) |
| is placement arrow anchor set | |
| virtual void | getPlacementPoints (ICoord2D *start, ICoord2D *end) |
| get the placemnt arrow points | |
| virtual Real | getPlacementAngle (void) |
| placement angle of drawable at cursor when placing down structures | |
| virtual void | selectDrawable (Drawable *draw) |
| Mark given Drawable as "selected". | |
| virtual void | deselectDrawable (Drawable *draw) |
| Clear "selected" status from Drawable. | |
| virtual void | deselectAllDrawables (Bool postMsg=true) |
| Clear the "select" flag from all drawables. | |
| virtual Int | getSelectCount (void) |
| Get count of currently selected drawables. | |
| virtual Int | getMaxSelectCount (void) |
| Get the max number of selected drawables. | |
| virtual UnsignedInt | getFrameSelectionChanged (void) |
| Get the max number of selected drawables. | |
| virtual const DrawableList * | getAllSelectedDrawables (void) const |
| Return the list of all the currently selected Drawable IDs. | |
| virtual const DrawableList * | getAllSelectedLocalDrawables (void) |
| Return the list of all the currently selected Drawable IDs owned by the current player. | |
| virtual Drawable * | getFirstSelectedDrawable (void) |
| get the first selected drawable (if any) | |
| virtual DrawableID | getSoloNexusSelectedDrawableID (void) |
| Return the one drawable of the nexus if only 1 angry mob is selected. | |
| virtual Bool | isDrawableSelected (DrawableID idToCheck) const |
| Return true if the selected ID is in the drawable list. | |
| virtual Bool | isAnySelectedKindOf (KindOfType kindOf) const |
| is any selected object a kind of | |
| virtual Bool | isAllSelectedKindOf (KindOfType kindOf) const |
| are all selected objects a kind of | |
| virtual void | setRadiusCursor (RadiusCursorType r, const SpecialPowerTemplate *sp, WeaponSlotType wslot) |
| virtual void | setRadiusCursorNone () |
| virtual void | setInputEnabled (Bool enable) |
| Set the input enabled or disabled. | |
| virtual Bool | getInputEnabled (void) |
| Get the current input status. | |
| virtual void | disregardDrawable (Drawable *draw) |
| Drawable is being destroyed, clean up any UI elements associated with it. | |
| virtual void | preDraw (void) |
| Logic which needs to occur before the UI renders. | |
| virtual void | postDraw (void) |
| Logic which needs to occur after the UI renders. | |
| virtual void | playMovie (const AsciiString &movieName) |
| Ingame video playback. | |
| virtual void | stopMovie (void) |
| virtual VideoBuffer * | videoBuffer (void) |
| virtual void | playCameoMovie (const AsciiString &movieName) |
| Ingame cameo video playback. | |
| virtual void | stopCameoMovie (void) |
| virtual VideoBuffer * | cameoVideoBuffer (void) |
| virtual DrawableID | getMousedOverDrawableID (void) const |
| Get drawble ID of drawable under cursor. | |
| virtual void | setQuitMenuVisible (Bool t) |
| Set the ingame flag as to if we have the Quit menu up or not. | |
| virtual Bool | isQuitMenuVisible (void) const |
| virtual const FieldParse * | getFieldParse (void) const |
| Bool | areSelectedObjectsControllable () const |
| Bool | canSelectedObjectsNonAttackInteractWithObject (const Object *objectToInteractWith, SelectionRules rule) const |
| CanAttackResult | getCanSelectedObjectsAttack (ActionType action, const Object *objectToInteractWith, SelectionRules rule, Bool additionalChecking=FALSE) const |
| Bool | canSelectedObjectsDoAction (ActionType action, const Object *objectToInteractWith, SelectionRules rule, Bool additionalChecking=FALSE) const |
| Bool | canSelectedObjectsDoSpecialPower (const CommandButton *command, const Object *objectToInteractWith, const Coord3D *position, SelectionRules rule, UnsignedInt commandOptions, Object *ignoreSelObj) const |
| Bool | canSelectedObjectsEffectivelyUseWeapon (const CommandButton *command, const Object *objectToInteractWith, const Coord3D *position, SelectionRules rule) const |
| Bool | canSelectedObjectsOverrideSpecialPowerDestination (const Coord3D *loc, SelectionRules rule, SpecialPowerType spType=SPECIAL_INVALID) const |
| virtual Int | selectUnitsMatchingCurrentSelection () |
| selects matching units | |
| virtual Int | selectMatchingAcrossScreen () |
| selects matching units across screen | |
| virtual Int | selectMatchingAcrossMap () |
| selects matching units across map | |
| virtual Int | selectMatchingAcrossRegion (IRegion2D *region) |
| virtual Int | selectAllUnitsByType (KindOfMaskType mustBeSet, KindOfMaskType mustBeClear) |
| virtual Int | selectAllUnitsByTypeAcrossScreen (KindOfMaskType mustBeSet, KindOfMaskType mustBeClear) |
| virtual Int | selectAllUnitsByTypeAcrossMap (KindOfMaskType mustBeSet, KindOfMaskType mustBeClear) |
| virtual Int | selectAllUnitsByTypeAcrossRegion (IRegion2D *region, KindOfMaskType mustBeSet, KindOfMaskType mustBeClear) |
| virtual void | buildRegion (const ICoord2D *anchor, const ICoord2D *dest, IRegion2D *region) |
| builds a region around the specified coordinates | |
| virtual Bool | getDisplayedMaxWarning (void) |
| virtual void | setDisplayedMaxWarning (Bool selected) |
| virtual void | addFloatingText (const UnicodeString &text, const Coord3D *pos, Color color) |
| AsciiString | getDrawableCaptionFontName (void) |
| Int | getDrawableCaptionPointSize (void) |
| Bool | isDrawableCaptionBold (void) |
| Color | getDrawableCaptionColor (void) |
| Bool | shouldMoveRMBScrollAnchor (void) |
| Bool | isClientQuiet (void) const |
| Bool | isInWaypointMode (void) const |
| Bool | isInForceAttackMode (void) const |
| Bool | isInForceMoveToMode (void) const |
| Bool | isInPreferSelectionMode (void) const |
| void | setClientQuiet (Bool enabled) |
| void | setWaypointMode (Bool enabled) |
| void | setForceMoveMode (Bool enabled) |
| void | setForceAttackMode (Bool enabled) |
| void | setPreferSelectionMode (Bool enabled) |
| void | toggleAttackMoveToMode (void) |
| Bool | isInAttackMoveToMode (void) const |
| void | clearAttackMoveToMode (void) |
| void | setCameraRotateLeft (Bool set) |
| void | setCameraRotateRight (Bool set) |
| void | setCameraZoomIn (Bool set) |
| void | setCameraZoomOut (Bool set) |
| void | setCameraTrackingDrawable (Bool set) |
| Bool | isCameraRotatingLeft () const |
| Bool | isCameraRotatingRight () const |
| Bool | isCameraZoomingIn () const |
| Bool | isCameraZoomingOut () const |
| Bool | isCameraTrackingDrawable () const |
| void | resetCamera () |
| virtual void | addIdleWorker (Object *obj) |
| virtual void | removeIdleWorker (Object *obj, Int playerNumber) |
| virtual void | selectNextIdleWorker (void) |
| virtual void | recreateControlBar (void) |
| virtual void | disableTooltipsUntil (UnsignedInt frameNum) |
| virtual void | clearTooltipsDisabled () |
| virtual Bool | areTooltipsDisabled () const |
| Bool | getDrawRMBScrollAnchor () const |
| Bool | getMoveRMBScrollAnchor () const |
| void | setDrawRMBScrollAnchor (Bool b) |
| void | setMoveRMBScrollAnchor (Bool b) |
| void | registerWindowLayout (WindowLayout *layout) |
| void | unregisterWindowLayout (WindowLayout *layout) |
| void | triggerDoubleClickAttackMoveGuardHint (void) |
| void | addWorldAnimation (Anim2DTemplate *animTemplate, const Coord3D *pos, WorldAnimationOptions options, Real durationInSeconds, Real zRisePerSecond) |
Public Member Functions inherited from SubsystemInterface | |
| SubsystemInterface () | |
| virtual | ~SubsystemInterface () |
| virtual void | postProcessLoad () |
| void | UPDATE (void) |
| void | DRAW (void) |
| AsciiString | getName (void) |
| void | setName (AsciiString name) |
Public Member Functions inherited from Snapshot | |
| Snapshot (void) | |
| ~Snapshot (void) | |
Protected Member Functions | |
| virtual View * | createView (void) |
| factory for views | |
| virtual void | drawSelectionRegion (void) |
| draw the selection region on screen | |
| virtual void | drawMoveHints (View *view) |
| draw move hint visual feedback | |
| virtual void | drawAttackHints (View *view) |
| draw attack hint visual feedback | |
| virtual void | drawPlaceAngle (View *view) |
| draw place building angle if needed | |
Protected Member Functions inherited from InGameUI | |
| virtual void | crc (Xfer *xfer) |
| virtual void | xfer (Xfer *xfer) |
| virtual void | loadPostProcess (void) |
| void | destroyPlacementIcons (void) |
| Destroy placement icons. | |
| void | handleBuildPlacements (void) |
| handle updating of placement icons based on mouse pos | |
| void | handleRadiusCursor () |
| handle updating of "radius cursors" that follow the mouse pos | |
| void | incrementSelectCount (void) |
| Increase by one the running total of "selected" drawables. | |
| void | decrementSelectCount (void) |
| Decrease by one the running total of "selected" drawables. | |
| void | evaluateSoloNexus (Drawable *newlyAddedDrawable=NULL) |
| void | expireHint (HintType type, UnsignedInt hintIndex) |
| expire a hint from of the specified type at the hint index | |
| void | createControlBar (void) |
| create the control bar user interface | |
| void | createReplayControl (void) |
| create the replay control window | |
| void | setMouseCursor (Mouse::MouseCursor c) |
| void | addMessageText (const UnicodeString &formattedMessage, const RGBColor *rgbColor=NULL) |
| internal workhorse for adding plain text for messages | |
| void | removeMessageAtIndex (Int i) |
| remove the message at index i | |
| void | updateFloatingText (void) |
| Update function to move our floating text. | |
| void | drawFloatingText (void) |
| Draw all our floating text. | |
| void | clearFloatingText (void) |
| clear the floating text list | |
| void | clearWorldAnimations (void) |
| delete all world animations | |
| void | updateAndDrawWorldAnimations (void) |
| update and draw visible world animations | |
| SuperweaponInfo * | findSWInfo (Int playerIndex, const AsciiString &powerName, ObjectID id, const SpecialPowerTemplate *powerTemplate) |
Implementation for the W3D game user interface. This singleton is responsible for all user interaction and feedback with as part of the user interface
Definition at line 56 of file W3DInGameUI.h.
| W3DInGameUI::W3DInGameUI | ( | ) |
Definition at line 271 of file W3DInGameUI.cpp.
|
virtual |
Definition at line 290 of file W3DInGameUI.cpp.
|
inlineprotectedvirtual |
|
virtual |
Render the in-game user interface.
Draw member for the W3D implemenation of the game user interface
Implements InGameUI.
Definition at line 393 of file W3DInGameUI.cpp.
|
protectedvirtual |
draw attack hint visual feedback
Draw visual back for clicking to attack a unit in the world
Definition at line 590 of file W3DInGameUI.cpp.
|
protectedvirtual |
draw move hint visual feedback
Draw the visual feedback for clicking in the world and telling units to move there
Definition at line 468 of file W3DInGameUI.cpp.
|
protectedvirtual |
draw place building angle if needed
Draw the angle selection for placing building if needed
Definition at line 598 of file W3DInGameUI.cpp.
|
protectedvirtual |
draw the selection region on screen
draw 2d selection region on screen
Definition at line 450 of file W3DInGameUI.cpp.
|
virtual |
Initialize the in-game user interface.
Reimplemented from InGameUI.
Definition at line 343 of file W3DInGameUI.cpp.
|
virtual |
Reset.
Reset the in game ui
Reimplemented from InGameUI.
Definition at line 382 of file W3DInGameUI.cpp.
|
virtual |
|
protected |
Definition at line 84 of file W3DInGameUI.h.
|
protected |
Definition at line 85 of file W3DInGameUI.h.
|
protected |
Definition at line 83 of file W3DInGameUI.h.
|
protected |
Definition at line 82 of file W3DInGameUI.h.