runelite-api: add GE search event and variables

This commit is contained in:
Ron Young
2019-10-07 09:19:16 -05:00
committed by Adam
parent 36d41737f3
commit 37db307cda
2 changed files with 67 additions and 0 deletions

View File

@@ -1709,4 +1709,19 @@ public interface Client extends GameEngine
* Makes all widgets behave as if they are {@link WidgetConfig#WIDGET_USE_TARGET}
*/
void setAllWidgetsAreOpTargetable(boolean value);
/**
* Sets the result count for GE search
*/
void setGeSearchResultCount(int count);
/**
* Sets the array of item ids for GE search
*/
void setGeSearchResultIds(short[] ids);
/**
* Sets the starting index in the item id array for GE search
*/
void setGeSearchResultIndex(int index);
}

View File

@@ -0,0 +1,52 @@
/*
* Copyright (c) 2019, Ron Young <https://github.com/raiyni>
* 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.Data;
/**
* An event where the Grand Exchange has been searched.
*/
@Data
public class GrandExchangeSearched
{
/**
* Whether or not the event has been consumed by a subscriber.
*/
private boolean consumed;
/**
* Marks the event as having been consumed.
* <p>
* Setting this state indicates that a plugin has set the GE
* search results and that the event will not be passed on
* for handling by vanilla client code.
*/
public void consume()
{
this.consumed = true;
}
}