ButtonState Class Reference

Public Types
enum	ClickCriteria { ByDuration , ByMargin , ByDurationAndMargin }

Public Member Functions
bool	IsInDoubleClickDuration ()
void	Update ()
void	Consume ()
void	Clear ()

Public Attributes
string	id
float	pressedTimer
float	timeSinceLastClick
float	timeSinceLastButtonDown
float	clickDuration = 0.5f
float	dragMargin = 12f
int	mouse = -1
EInput.KeyMap	keymap
bool	down
bool	up
bool	pressing
bool	clicked
bool	doubleClicked
bool	consumed
bool	dragging
bool	dragging2
bool	draggedOverMargin
bool	ignoreClick
bool	wasConsumed
bool	usedMouse
bool	usedKey
bool	ignoreWheel
ClickCriteria	clickCriteria = ClickCriteria.ByDurationAndMargin
Action	pressedLongAction

Static Public Attributes
static float	delta

Properties
bool	pressedLong [get]

Detailed Description

Definition at line 4 of file ButtonState.cs.

Member Enumeration Documentation

ClickCriteria

enum ButtonState.ClickCriteria

Enumerator
ByDuration
ByMargin
ByDurationAndMargin

Definition at line 6 of file ButtonState.cs.

    {
        ByDuration,
        ByMargin,
        ByDurationAndMargin
    }

Member Function Documentation

Clear()

void ButtonState.Clear ( )

inline

Definition at line 190 of file ButtonState.cs.

    {
        pressedTimer = 0f;
        down = (up = (pressing = false));
        usedKey = (usedMouse = (clicked = (doubleClicked = (dragging = (draggedOverMargin = (ignoreClick = false))))));
    }

References clicked, doubleClicked, down, draggedOverMargin, dragging, ignoreClick, pressedTimer, pressing, up, usedKey, and usedMouse.

Referenced by Consume(), and Update().

Consume()

void ButtonState.Consume ( )

inline

Definition at line 184 of file ButtonState.cs.

    {
        Clear();
        consumed = (wasConsumed = true);
    }

References Clear(), consumed, and wasConsumed.

Referenced by EInput.Consume(), UIHangIcon.OnClick(), AM_BaseGameMode.OnUpdateInput(), ButtonAbility.TryUse(), and ActionMode.UpdateInput().

IsInDoubleClickDuration()

bool ButtonState.IsInDoubleClickDuration ( )

inline

Definition at line 75 of file ButtonState.cs.

    {
        return timeSinceLastClick < 0.2f;
    }

References timeSinceLastClick.

Update()

void ButtonState.Update ( )

inline

Definition at line 80 of file ButtonState.cs.

    {
        timeSinceLastClick += delta;
        if (mouse != -1 && !usedKey)
        {
            down = Input.GetMouseButtonDown(mouse);
            up = Input.GetMouseButtonUp(mouse);
            pressing = Input.GetMouseButton(mouse);
            if (down)
            {
                usedMouse = true;
            }
        }
        if (mouse == 1)
        {
            if (down)
            {
                EInput.dragStartPos2 = EInput.mpos;
            }
            else if (pressing)
            {
                if (Vector3.Distance(EInput.mpos, EInput.dragStartPos2) > dragMargin)
                {
                    dragging2 = true;
                }
            }
            else
            {
                dragging2 = false;
            }
        }
        if (keymap != null && !usedMouse && !EInput.isInputFieldActive)
        {
            down = Input.GetKeyDown(keymap.key);
            up = Input.GetKeyUp(keymap.key);
            pressing = Input.GetKey(keymap.key);
            if (down)
            {
                usedKey = true;
            }
        }
        if (consumed)
        {
            if (down || up || pressing)
            {
                Clear();
                return;
            }
            consumed = false;
        }
        if (down)
        {
            wasConsumed = false;
            EInput.dragStartPos = EInput.mpos;
            if (timeSinceLastClick < 0.2f)
            {
                doubleClicked = true;
            }
        }
        else if (pressing)
        {
            pressedTimer += delta;
            if (EInput.mpos != EInput.dragStartPos)
            {
                dragging = true;
            }
            if (Vector3.Distance(EInput.mpos, EInput.dragStartPos) > dragMargin)
            {
                draggedOverMargin = true;
            }
        }
        else if (up)
        {
            if (ignoreWheel)
            {
                EInput.ignoreWheelDuration = 0.2f;
            }
            switch (clickCriteria)
            {
            case ClickCriteria.ByDuration:
                clicked = pressedTimer < clickDuration;
                break;
            case ClickCriteria.ByMargin:
                clicked = !draggedOverMargin;
                break;
            case ClickCriteria.ByDurationAndMargin:
                clicked = !draggedOverMargin && pressedTimer < clickDuration;
                break;
            }
            if (clicked)
            {
                timeSinceLastClick = 0f;
            }
            if (ignoreClick)
            {
                clicked = false;
            }
        }
        else
        {
            Clear();
        }
    }

References Clear(), clickCriteria, clickDuration, clicked, consumed, delta, doubleClicked, down, draggedOverMargin, dragging, dragging2, dragMargin, EInput.dragStartPos, EInput.dragStartPos2, ignoreClick, ignoreWheel, EInput.isInputFieldActive, keymap, mouse, EInput.mpos, pressedTimer, pressing, timeSinceLastClick, up, usedKey, usedMouse, and wasConsumed.

Referenced by EInput.Update().

Member Data Documentation

clickCriteria

ClickCriteria ButtonState.clickCriteria = ClickCriteria.ByDurationAndMargin

Definition at line 59 of file ButtonState.cs.

Referenced by Update().

clickDuration

float ButtonState.clickDuration = 0.5f

Definition at line 23 of file ButtonState.cs.

Referenced by AM_Adv._OnUpdateInput(), and Update().

clicked

bool ButtonState.clicked

Definition at line 37 of file ButtonState.cs.

Referenced by AM_Adv._OnUpdateInput(), AM_Sim._OnUpdateInput(), AM_ViewZone._OnUpdateInput(), Clear(), EInput.IsAnyKeyDown(), ActionMode.IsFuncPressed(), AM_Adv.PressedAction.IsPressing(), ButtonAbility.OnMiddleClick(), ButtonGrid.OnMiddleClick(), BaseTileSelector.OnUpdate(), AM_Cinema.OnUpdateInput(), AM_Paint.OnUpdateInput(), LayerImage.OnUpdateInput(), LayerMiniGame.OnUpdateInput(), LayerSkinDeco.OnUpdateInput(), LayerWidget.OnUpdateInput(), AM_Adv.PressedActionMove(), LayerTextureViewer.Update(), Update(), UIScreenshot.Update(), and ActionMode.UpdateInput().

consumed

bool ButtonState.consumed

Definition at line 41 of file ButtonState.cs.

Referenced by Consume(), and Update().

delta

float ButtonState.delta

static

Definition at line 13 of file ButtonState.cs.

Referenced by Update().

doubleClicked

bool ButtonState.doubleClicked

Definition at line 39 of file ButtonState.cs.

Referenced by Clear(), and Update().

down

bool ButtonState.down

Definition at line 31 of file ButtonState.cs.

Referenced by AM_Adv._OnUpdateInput(), AM_ADV_Target._OnUpdateInput(), AM_Sim._OnUpdateInput(), Clear(), AM_Adv.PressedAction.IsPressing(), BaseTileSelector.OnUpdate(), Scene.OnUpdate(), AM_BaseGameMode.OnUpdateInput(), AM_Bird.OnUpdateInput(), AM_Cinema.OnUpdateInput(), AM_Select.OnUpdateInput(), LayerAbility.OnUpdateInput(), LayerSkinDeco.OnUpdateInput(), DramaEventTalk.Play(), AM_Adv.PressedActionMove(), InvOwner.Transaction.Process(), LayerCraftFloat.Update(), Update(), UIDragGridIngredients.Update(), ActionMode.UpdateInput(), and Layer.UpdateInput().

draggedOverMargin

bool ButtonState.draggedOverMargin

Definition at line 47 of file ButtonState.cs.

Referenced by AM_Sim._OnUpdateInput(), Clear(), and Update().

dragging

bool ButtonState.dragging

Definition at line 43 of file ButtonState.cs.

Referenced by Clear(), AM_BaseTerrain.OnUpdateInput(), LayerSkinDeco.OnUpdateInput(), LayerWidget.OnUpdateInput(), and Update().

dragging2

bool ButtonState.dragging2

Definition at line 45 of file ButtonState.cs.

Referenced by Update(), and ActionMode.UpdateInput().

dragMargin

float ButtonState.dragMargin = 12f

Definition at line 25 of file ButtonState.cs.

Referenced by Update().

id

string ButtonState.id

Definition at line 15 of file ButtonState.cs.

ignoreClick

bool ButtonState.ignoreClick

Definition at line 49 of file ButtonState.cs.

Referenced by Clear(), and Update().

ignoreWheel

bool ButtonState.ignoreWheel

Definition at line 57 of file ButtonState.cs.

Referenced by Update().

keymap

EInput.KeyMap ButtonState.keymap

Definition at line 29 of file ButtonState.cs.

Referenced by Update().

mouse

int ButtonState.mouse = -1

Definition at line 27 of file ButtonState.cs.

Referenced by Update().

pressedLongAction

Action ButtonState.pressedLongAction

Definition at line 61 of file ButtonState.cs.

Referenced by ActionMode.UpdateInput().

pressedTimer

float ButtonState.pressedTimer

Definition at line 17 of file ButtonState.cs.

Referenced by AM_Adv._OnUpdateInput(), Clear(), InvOwner.OnRightPressed(), AM_ViewZone.OnScroll(), and Update().

pressing

bool ButtonState.pressing

Definition at line 35 of file ButtonState.cs.

Referenced by AM_Adv._OnUpdateInput(), TaskBuild.CanRotateBlock(), Clear(), BaseTileMap.Draw(), Scene.Init(), ActionMode.InputMovement(), AM_Adv.PressedAction.IsPressing(), BaseGameScreen.ModTargetZoomIndex(), BaseTileSelector.OnUpdate(), Scene.OnUpdate(), AM_BaseTerrain.OnUpdateInput(), DramaEventEndRoll.Play(), TaskPoint.Run(), ButtonAbility.TryUse(), Update(), and ActionMode.UpdateInput().

timeSinceLastButtonDown

float ButtonState.timeSinceLastButtonDown

Definition at line 21 of file ButtonState.cs.

timeSinceLastClick

float ButtonState.timeSinceLastClick

Definition at line 19 of file ButtonState.cs.

Referenced by IsInDoubleClickDuration(), and Update().

up

bool ButtonState.up

Definition at line 33 of file ButtonState.cs.

Referenced by Clear(), and Update().

usedKey

bool ButtonState.usedKey

Definition at line 55 of file ButtonState.cs.

Referenced by Clear(), ButtonAbility.TryUse(), and Update().

usedMouse

bool ButtonState.usedMouse

Definition at line 53 of file ButtonState.cs.

Referenced by Clear(), and Update().

wasConsumed

bool ButtonState.wasConsumed

Definition at line 51 of file ButtonState.cs.

Referenced by Consume(), UIButton.OnPointerDown(), and Update().

Property Documentation

pressedLong

bool ButtonState.pressedLong

get

Definition at line 63 of file ButtonState.cs.

    {
        get
        {
            if (pressing)
            {
                return pressedTimer >= clickDuration;
            }
            return false;
        }
    }

Referenced by AM_Adv._OnUpdateInput(), ActionMode.IsFuncPressed(), InvOwner.OnRightPressed(), BaseTileSelector.OnUpdate(), DramaEventEndRoll.Play(), AM_Adv.RefreshArrow(), ButtonAbility.TryUse(), UIInputText.Update(), and ActionMode.UpdateInput().

---

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

• Elin/Plugins.basecore/ButtonState.cs