Skip to content

Commit

Permalink
runelite-api: Add queries
Browse files Browse the repository at this point in the history
  • Loading branch information
devinfrench authored and Adam- committed May 7, 2017
1 parent 71dac53 commit feda25f
Show file tree
Hide file tree
Showing 8 changed files with 239 additions and 4 deletions.
6 changes: 6 additions & 0 deletions runelite-api/src/main/java/net/runelite/api/Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ public Player[] getPlayers()
.toArray(size -> new Player[size]);
}

@SuppressWarnings("unchecked")
public <T> T[] runQuery(Query query)
{
return (T[]) query.result(this);
}

public int getBoostedSkillLevel(Skill skill)
{
int[] boostedLevels = client.getBoostedSkillLevels();
Expand Down
2 changes: 1 addition & 1 deletion runelite-api/src/main/java/net/runelite/api/NPC.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public NPC(Client client, net.runelite.rs.api.NPC npc)
@Override
public String getName()
{
return npc.getComposition().getName();
return npc.getComposition().getName().replace('\u00A0', ' ');
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion runelite-api/src/main/java/net/runelite/api/Player.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public Player(Client client, net.runelite.rs.api.Player player)
@Override
public String getName()
{
return player.getName();
return player.getName().replace('\u00A0', ' ');
}

@Override
Expand Down
47 changes: 47 additions & 0 deletions runelite-api/src/main/java/net/runelite/api/Query.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
* Copyright (c) 2017, Devin French <https://github.com/devinfrench>
* 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;

import java.util.function.Predicate;

public abstract class Query<EntityType, QueryType>
{
protected Predicate<EntityType> predicate;

protected Query()
{
}

protected abstract EntityType[] result(Client client);

protected Predicate<EntityType> and(Predicate<EntityType> other)
{
if (predicate == null)
{
return other;
}
return predicate.and(other);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
* Copyright (c) 2017, Devin French <https://github.com/devinfrench>
* 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.queries;

import net.runelite.api.Actor;
import net.runelite.api.Point;
import net.runelite.api.Query;

public abstract class ActorQuery<EntityType extends Actor, QueryType> extends Query<EntityType, QueryType>
{
@SuppressWarnings("unchecked")
public QueryType nameEquals(String... names)
{
predicate = and(actor ->
{
for (String name : names)
{
String actorName = actor.getName();
if (actorName != null && actorName.equals(name))
{
return true;
}
}
return false;
});
return (QueryType) this;
}

@SuppressWarnings("unchecked")
public QueryType nameContains(String... names)
{
predicate = and(actor ->
{
for (String name : names)
{
String actorName = actor.getName();
if (actorName != null && actorName.contains(name))
{
return true;
}
}
return false;
});
return (QueryType) this;
}

@SuppressWarnings("unchecked")
public QueryType atLocalLocation(Point location)
{
predicate = and(actor -> actor.getLocalLocation().equals(location));
return (QueryType) this;
}

@SuppressWarnings("unchecked")
public QueryType isLevel(int level)
{
predicate = and(actor -> actor.getCombatLevel() == level);
return (QueryType) this;
}

@SuppressWarnings("unchecked")
public QueryType animationEquals(int animation)
{
predicate = and(actor -> actor.getAnimation() == animation);
return (QueryType) this;
}

@SuppressWarnings("unchecked")
public QueryType isInteractingWith(Actor actor)
{
predicate = and(a -> a.getInteracting().equals(a));
return (QueryType) this;
}
}
43 changes: 43 additions & 0 deletions runelite-api/src/main/java/net/runelite/api/queries/NPCQuery.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright (c) 2017, Devin French <https://github.com/devinfrench>
* 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.queries;

import net.runelite.api.Client;
import net.runelite.api.NPC;

import java.util.Arrays;
import java.util.Objects;

public class NPCQuery extends ActorQuery<NPC, NPCQuery>
{
@Override
protected NPC[] result(Client client)
{
return Arrays.stream(client.getNpcs())
.filter(Objects::nonNull)
.filter(predicate)
.toArray(NPC[]::new);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright (c) 2017, Devin French <https://github.com/devinfrench>
* 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.queries;

import net.runelite.api.Client;
import net.runelite.api.Player;

import java.util.Arrays;
import java.util.Objects;

public class PlayerQuery extends ActorQuery<Player, PlayerQuery>
{
@Override
protected Player[] result(Client client)
{
return Arrays.stream(client.getPlayers())
.filter(Objects::nonNull)
.filter(predicate)
.toArray(Player[]::new);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ private int getRelativeY()

public String getText()
{
return widget.getText();
return widget.getText().replace('\u00A0', ' ');
}

public void setText(String text)
Expand All @@ -124,7 +124,7 @@ public int getTextColor()

public String getName()
{
return widget.getName();
return widget.getName().replace('\u00A0', ' ');
}

public int getModelId()
Expand Down

0 comments on commit feda25f

Please sign in to comment.