Inheritance diagram for HotItem:

Public Member Functions
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)

Public Attributes
ButtonHotItem	button

Hotbar	hotbar

bool	disabled

Public Attributes inherited from UIButton.Item
bool	always

Properties
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 4 of file HotItem.cs.

Member Function Documentation

◆ CanAutoFire()

virtual bool HotItem.CanAutoFire ( Chara tg )

inlinevirtual

Definition at line 74 of file HotItem.cs.

    {
        return false;
    }

◆ OnClick()

virtual void HotItem.OnClick	(	ButtonHotItem	b,
		Hotbar	h
	)

inlinevirtual

Reimplemented in HotAction, HotItemActionMode, HotItemFocusChara, HotItemGameAction, HotItemLayer, HotItemSpeed, HotItemToggle, HotItemTogglePage, HotItemToggleVisible, and HotItemWidget.

Definition at line 64 of file HotItem.cs.

    {
        OnClick(b);
    }

References OnClick().

Referenced by OnClick().

◆ OnMarkMapHighlights()

virtual void HotItem.OnMarkMapHighlights ( )

inlinevirtual

Reimplemented in HotItemGameAction.

Definition at line 112 of file HotItem.cs.

113 {

114 }

Referenced by Player.MarkMapHighlights().

◆ OnRenderTile()

virtual void HotItem.OnRenderTile	(	Point	point,
		HitResult	result,
		int	dir
	)

inlinevirtual

Reimplemented in HotItemHeld.

Definition at line 116 of file HotItem.cs.

117 {

118 }

Referenced by AM_Adv.OnRenderTile().

◆ OnRightClick()

virtual void HotItem.OnRightClick ( ButtonHotItem b )

inlinevirtual

Reimplemented in HotItemGameAction.

Definition at line 69 of file HotItem.cs.

    {
        b.widget?.ShowContextMenu();
    }

References Widget.ShowContextMenu(), and ButtonHotItem.widget.

◆ OnSetCurrentItem()

virtual void HotItem.OnSetCurrentItem ( )

inlinevirtual

Reimplemented in HotItemHeld.

Definition at line 79 of file HotItem.cs.

80 {

81 }

Referenced by Player.RefreshCurrentHotItem().

◆ OnUnselect()

virtual void HotItem.OnUnselect ( )

inlinevirtual

Reimplemented in HotItemHeld.

Definition at line 87 of file HotItem.cs.

88 {

89 }

Referenced by Hotbar.Unselect().

◆ OnUnsetCurrentItem()

virtual void HotItem.OnUnsetCurrentItem ( )

inlinevirtual

Definition at line 83 of file HotItem.cs.

84 {

85 }

Referenced by Player.RefreshCurrentHotItem().

◆ SetImage()

virtual void HotItem.SetImage ( Image icon )

inlinevirtual

Reimplemented in HotItemAct, and HotItemThing.

Definition at line 91 of file HotItem.cs.

    {
        icon.sprite = GetSprite() ?? EClass.core.refs.icons.defaultHotItem;
        icon.color = SpriteColor;
        icon.transform.localScale = SpriteScale;
        icon.rectTransform.pivot = new Vector2(0.5f, 0.5f);
        if (AdjustImageSize)
        {
            icon.SetNativeSize();
        }
        else
        {
            icon.Rect().sizeDelta = new Vector2(48f, 48f);
        }
    }

References UIButton.Item.AdjustImageSize, EClass.core, CoreRef.Icons.defaultHotItem, UIButton.Item.GetSprite(), CoreRef.icons, Core.refs, UIButton.Item.SpriteColor, and UIButton.Item.SpriteScale.

Referenced by WidgetCurrentTool._RefreshCurrentHotItem(), and ActPlan.Update().

◆ TextHotkey()

string HotItem.TextHotkey ( )

inline

Definition at line 50 of file HotItem.cs.

    {
        if (!hotbar.ShowFunctionKey)
        {
            return "";
        }
        int num = hotbar.CurrentPage.items.IndexOf(this) + 1;
        if (num > 8)
        {
            return "";
        }
        return " (F" + num + ")";
    }

References Hotbar.CurrentPage, hotbar, Hotbar.Page.items, and Hotbar.ShowFunctionKey.

◆ TrySetAct()

virtual bool HotItem.TrySetAct ( ActPlan p )

inlinevirtual

Reimplemented in HotItemAct, HotItemChara, HotItemHeld, and HotItemNoItem.

Definition at line 107 of file HotItem.cs.

    {
        return false;
    }

Referenced by ActPlan._Update().

Member Data Documentation

◆ button

ButtonHotItem HotItem.button

Definition at line 6 of file HotItem.cs.

◆ disabled

bool HotItem.disabled

Definition at line 10 of file HotItem.cs.

◆ hotbar

Hotbar HotItem.hotbar

Definition at line 8 of file HotItem.cs.

Referenced by HotItemGameAction.OnClick(), HotItemGameAction.OnRightClick(), and TextHotkey().

Property Documentation

◆ IsGameAction

virtual bool HotItem.IsGameAction

get

Definition at line 46 of file HotItem.cs.

Referenced by ActPlan._Update().

◆ IsSelectable

override bool HotItem.IsSelectable

get

Definition at line 14 of file HotItem.cs.

◆ IsTool

virtual bool HotItem.IsTool

get

Definition at line 42 of file HotItem.cs.

◆ LookAtMouse

virtual bool HotItem.LookAtMouse

get

Definition at line 44 of file HotItem.cs.

Referenced by AM_Adv._OnUpdateInput().

◆ RenderThing

virtual Thing HotItem.RenderThing

get

Definition at line 18 of file HotItem.cs.

    {
        get
        {
            if (EClass.pc.ai.RenderThing == null)
            {
                if (EClass.player.renderThing == null)
                {
                    if (!(Thing?.trait is TraitAbility))
                    {
                        return Thing;
                    }
                    return null;
                }
                return EClass.player.renderThing;
            }
            return EClass.pc.ai.RenderThing;
        }
    }

Referenced by CharaActorPCC.OnRender().

◆ SpriteHighlight

override Sprite HotItem.SpriteHighlight

get

Definition at line 12 of file HotItem.cs.

◆ TextTip

override string HotItem.TextTip

get

Definition at line 16 of file HotItem.cs.

◆ Thing

virtual Thing HotItem.Thing

get

Definition at line 38 of file HotItem.cs.

Referenced by AM_Adv._OnUpdateInput(), ActPlan._Update(), WidgetCurrentTool.OnClickButtonHotItem(), ConTorch.OnRemoved(), TraitAmmo.OnUse(), ButtonHotItem.Refresh(), UIPlaceHelper.Refresh(), TCOrbitChara.RefreshAll(), TCOrbitThing.RefreshAll(), Player.RefreshCurrentHotItem(), UIInventory.RefreshHighlight(), WidgetCurrentTool.RefreshHighlight(), Player.TargetRanged(), and Chara.TryEquipRanged().

◆ Tool

virtual Thing HotItem.Tool

get

Definition at line 40 of file HotItem.cs.

◆ UseUIObjMaterial

virtual bool HotItem.UseUIObjMaterial

get

Definition at line 48 of file HotItem.cs.

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

Elin/HotItem.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ CanAutoFire()

◆ OnClick()

◆ OnMarkMapHighlights()

◆ OnRenderTile()

◆ OnRightClick()

◆ OnSetCurrentItem()

◆ OnUnselect()

◆ OnUnsetCurrentItem()

◆ SetImage()

◆ TextHotkey()

◆ TrySetAct()

Member Data Documentation

◆ button

◆ disabled

◆ hotbar

Property Documentation

◆ IsGameAction

◆ IsSelectable

◆ IsTool

◆ LookAtMouse

◆ RenderThing

◆ SpriteHighlight

◆ TextTip

◆ Thing

◆ Tool

◆ UseUIObjMaterial