HotItemActionMode Class Reference

Inheritance diagram for HotItemActionMode:

Public Member Functions
override void	OnClick (ButtonHotItem b, Hotbar h)
override bool	ShouldHighlight ()
Public Member Functions inherited from HotItem
string	TextHotkey ()
virtual void	OnClick (ButtonHotItem b, Hotbar h)
virtual void	OnRightClick (ButtonHotItem b)
virtual bool	CanAutoFire (Chara tg)
virtual void	OnSetCurrentItem ()
virtual void	OnUnsetCurrentItem ()
virtual void	OnUnselect ()
virtual void	SetImage (Image icon)
virtual bool	TrySetAct (ActPlan p)
virtual void	OnMarkMapHighlights ()
virtual void	OnRenderTile (Point point, HitResult result, int dir)
Public Member Functions inherited from UIButton.Item
virtual Sprite	GetSprite ()
virtual Sprite	GetSprite (bool highlight)
virtual bool	ShouldHighlight ()
virtual void	OnAddedToBar ()
virtual void	OnShowContextMenu (UIContextMenu m)
virtual void	OnHover (UIButton b)
virtual void	OnClick (UIButton b)
virtual void	OnSetItem (UIButton b)
virtual void	SetSubText (UIText t)

Static Public Member Functions
static void	Execute (string id)

Public Attributes
string	id
Public Attributes inherited from HotItem
ButtonHotItem	button
Hotbar	hotbar
bool	disabled
Public Attributes inherited from UIButton.Item
bool	always

Properties
override string	Name [get]
override string	pathSprite [get]
override bool	KeepVisibleWhenHighlighted [get]
Properties inherited from HotItem
override Sprite	SpriteHighlight [get]
override bool	IsSelectable [get]
override string	TextTip [get]
virtual Thing	RenderThing [get]
virtual Thing	Thing [get]
virtual Thing	Tool [get]
virtual bool	IsTool [get]
virtual bool	LookAtMouse [get]
virtual bool	IsGameAction [get]
virtual bool	UseUIObjMaterial [get]
Properties inherited from UIButton.Item
virtual string	TextTip [get]
virtual string	Name [get]
virtual Sprite	SpriteHighlight [get]
virtual string	pathSprite [get]
virtual bool	IsSelectable [get]
virtual bool	AdjustImageSize [get]
virtual bool	UseIconForHighlight [get]
virtual bool	KeepVisibleWhenHighlighted [get]
virtual Color	SpriteColor [get]
virtual Vector3	SpriteScale [get]
virtual bool	Hidden [get]
virtual Transition	Transition [get]

Detailed Description

Definition at line 3 of file HotItemActionMode.cs.

Member Function Documentation

Execute()

static void HotItemActionMode.Execute ( string  id )

inlinestatic

Definition at line 14 of file HotItemActionMode.cs.

    {
        switch (id)
        {
        case "Inspect":
            if (!EClass.scene.actionMode.IsBuildMode)
            {
                BuildMenu.Toggle();
            }
            else
            {
                ActionMode.Inspect.Activate(toggle: false);
            }
            break;
        case "Cut":
            ActionMode.Cut.Activate(toggle: false);
            break;
        case "Mine":
            ActionMode.Mine.Activate(toggle: false);
            break;
        case "StateEditor":
            ActionMode.StateEditor.Activate(toggle: false);
            break;
        case "Dig":
            ActionMode.Dig.Activate(TaskDig.Mode.Default);
            break;
        case "DigFloor":
            ActionMode.Dig.Activate(TaskDig.Mode.RemoveFloor);
            break;
        case "RemoveDesignation":
            ActionMode.RemoveDesignation.Activate(toggle: false);
            break;
        case "Deconstruct":
            ActionMode.Deconstruct.Activate(toggle: false);
            break;
        case "EditArea":
            ActionMode.EditArea.Activate(toggle: false);
            break;
        case "Picker":
            ActionMode.Picker.Activate(toggle: false);
            break;
        case "Terrain":
            ActionMode.Terrain.Activate(toggle: false);
            break;
        case "Populate":
            ActionMode.Populate.Activate(toggle: false);
            break;
        case "EditMarker":
            ActionMode.EditMarker.Activate(toggle: false);
            break;
        case "Visibility":
            ActionMode.Visibility.Activate(toggle: false);
            break;
        case "Cinema":
            ActionMode.Cinema.Activate(toggle: false);
            break;
        case "FlagCell":
            ActionMode.FlagCell.Activate(toggle: false);
            break;
        case "ExitBuild":
            ActionMode.DefaultMode.Activate(toggle: false);
            break;
        case "Copy":
            ActionMode.Copy.Activate(toggle: false);
            break;
        }
    }

References Scene.actionMode, ActionMode.Activate(), AM_Dig.Activate(), AM_Mine.Activate(), AM_MoveInstalled.Activate(), ActionMode.Cinema, ActionMode.Copy, ActionMode.Cut, ActionMode.Deconstruct, ActionMode.DefaultMode, ActionMode.Dig, ActionMode.EditArea, ActionMode.EditMarker, ActionMode.FlagCell, ActionMode.Inspect, ActionMode.IsBuildMode, ActionMode.Mine, ActionMode.Picker, ActionMode.Populate, ActionMode.RemoveDesignation, EClass.scene, ActionMode.StateEditor, ActionMode.Terrain, BuildMenu.Toggle(), and ActionMode.Visibility.

Referenced by OnClick().

OnClick()

override void HotItemActionMode.OnClick ( ButtonHotItem  b, Hotbar  h  )

inlinevirtual

Reimplemented from HotItem.

Definition at line 82 of file HotItemActionMode.cs.

    {
        Execute(id);
    }

References Execute().

ShouldHighlight()

override bool HotItemActionMode.ShouldHighlight ( )

inlinevirtual

Reimplemented from UIButton.Item.

Definition at line 87 of file HotItemActionMode.cs.

    {
        ActionMode actionMode = EClass.scene.actionMode;
        switch (id)
        {
        case "Inspect":
            if (actionMode != ActionMode.Inspect)
            {
                return actionMode == ActionMode.Build;
            }
            return true;
        case "Cut":
            return actionMode == ActionMode.Cut;
        case "Mine":
            return actionMode == ActionMode.Mine;
        case "Dig":
            if (actionMode == ActionMode.Dig)
            {
                return ActionMode.Dig.mode == TaskDig.Mode.Default;
            }
            return false;
        case "DigFloor":
            if (actionMode == ActionMode.Dig)
            {
                return ActionMode.Dig.mode == TaskDig.Mode.RemoveFloor;
            }
            return false;
        case "RemoveDesignation":
            return actionMode == ActionMode.RemoveDesignation;
        case "StateEditor":
            return actionMode == ActionMode.StateEditor;
        case "Deconstruct":
            return actionMode == ActionMode.Deconstruct;
        case "Picker":
            return actionMode == ActionMode.Picker;
        case "EditArea":
            if (actionMode != ActionMode.EditArea && actionMode != ActionMode.CreateArea)
            {
                return actionMode == ActionMode.ExpandArea;
            }
            return true;
        case "Terrain":
            return actionMode == ActionMode.Terrain;
        case "EditMarker":
            return actionMode == ActionMode.EditMarker;
        case "Populate":
            return actionMode == ActionMode.Populate;
        case "Visibility":
            return actionMode == ActionMode.Visibility;
        case "Cinema":
            return actionMode == ActionMode.Cinema;
        case "Copy":
            return actionMode == ActionMode.Copy;
        case "FlagCell":
            return actionMode == ActionMode.FlagCell;
        default:
            return false;
        }
    }

References Scene.actionMode, ActionMode.Build, ActionMode.Cinema, ActionMode.Copy, ActionMode.CreateArea, ActionMode.Cut, ActionMode.Deconstruct, ActionMode.Dig, ActionMode.EditArea, ActionMode.EditMarker, ActionMode.ExpandArea, ActionMode.FlagCell, ActionMode.Inspect, ActionMode.Mine, ActionMode.Picker, ActionMode.Populate, ActionMode.RemoveDesignation, EClass.scene, ActionMode.StateEditor, ActionMode.Terrain, and ActionMode.Visibility.

Member Data Documentation

id

string HotItemActionMode.id

Definition at line 6 of file HotItemActionMode.cs.

Property Documentation

KeepVisibleWhenHighlighted

override bool HotItemActionMode.KeepVisibleWhenHighlighted

get

Definition at line 12 of file HotItemActionMode.cs.

Name

override string HotItemActionMode.Name

get

Definition at line 8 of file HotItemActionMode.cs.

pathSprite

override string HotItemActionMode.pathSprite

get

Definition at line 10 of file HotItemActionMode.cs.

---

The documentation for this class was generated from the following file:

• Elin/HotItemActionMode.cs