runelite/runelite-api/src/main/java/net/runelite/api/events/MenuOptionClicked.java

/*
 * Copyright (c) 2017, Robin <robin.weymans@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.api.events;

import lombok.AccessLevel;
import lombok.Data;
import lombok.Setter;
import net.runelite.api.MenuOpcode;
import net.runelite.api.MenuEntry;

/**
 * An event where a menu option has been clicked.
 * <p>
 * This event does not only trigger when clicking an option in a
 * right-clicked menu. The event will trigger for any left click
 * action performed (ie. clicking an item, walking to a tile, etc) as
 * well as any right-click menu option.
 * <p>
 * By default, when there is no action performed when left-clicking,
 * it seems that this event still triggers with the "Cancel" action.
 */
@Data
public class MenuOptionClicked implements Event
{
	public MenuOptionClicked(MenuEntry entry)
	{
		menuEntry = entry;
		authentic = true;
	}

	public MenuOptionClicked(MenuEntry entry, boolean authentic, int mouseButton)
	{
		menuEntry = entry;
		this.authentic = authentic;
		this.mouseButton = mouseButton;
	}

	/**
	 * The actual MenuEntry object representing what was clicked
	 */
	private MenuEntry menuEntry;

	/**
	 * The option text added to the menu.
	 */
	public String getOption()
	{
		return menuEntry.getOption();
	}

	/**
	 * The target of the action.
	 */
	public String getTarget()
	{
		return menuEntry.getTarget();
	}

	/**
	 * MenuOpcode but int-ish
	 */
	public int getOpcode()
	{
		return menuEntry.getOpcode();
	}

	/**
	 * The ID of the object, actor, or item that the interaction targets.
	 */
	public int getIdentifier()
	{
		return menuEntry.getIdentifier();
	}

	/**
	 * The action parameter used in the click.
	 */
	public int getActionParam0()
	{
		return menuEntry.getParam0();
	}

	/**
	 * shit docs
	 */
	public int getActionParam1()
	{
		return menuEntry.getParam1();
	}

	public boolean isForceLeftClick()
	{
		return menuEntry.isForceLeftClick();
	}

	/**
	 * The action performed.
	 */
	public MenuOpcode getMenuOpcode()
	{
		return MenuOpcode.of(getOpcode());
	}

	/**
	 * Whether or not the event has been consumed by a subscriber.
	 */
	private boolean consumed;

	/**
	 * The mouse button will be 1 if a non draggable widget was clicked,
	 */
	private int mouseButton;

	/**
	 * Marks the event as having been consumed.
	 * <p>
	 * Setting this state indicates that a plugin has processed the menu
	 * option being clicked and that the event will not be passed on
	 * for handling by vanilla client code.
	 */
	public void consume()
	{
		this.consumed = true;
	}

	/**
	 * Whether or not the event is authentic.
	 */
	@Setter(AccessLevel.PRIVATE)
	private boolean authentic;
}