ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

api: combine ExperienceChanged and BoostedLevelChanged events to StatChanged

Browse Source
This commit is contained in:
Adam
2019-11-04 09:32:52 -05:00
parent dad19290d9
commit 5b7423bfee
2 changed files with 9 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
runelite-api/src/main/java/net/runelite/api/events/BoostedLevelChanged.java
View File

@@ -1,51 +0,0 @@
/*
* Copyright (c) 2018, Adam <Adam@sigterm.info>
* 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;
import net.runelite.api.Skill;
/**
* An event where a players skill level has been temporarily modified.
* <p>
* Examples of when this event may trigger include:
* <ul>
* <li>Prayer points draining or being restored at an altar or restoration pool</li>
* <li>Positive and negative effects gained from potions (ie. Saradomin brew)</li>
* <li>Earning skill points towards a skill</li>
* <li>Levelling up a skill</li>
* </ul>
* <p>
* Use {@link net.runelite.api.Client#getBoostedSkillLevel(Skill)} in order to
* retrieve the newly boosted skill level.
*/
@Data
public class BoostedLevelChanged
{
/**
* The skill that has had its level modified.
*/
private Skill skill;
}

19
runelite-api/src/main/java/net/runelite/api/events/ExperienceChanged.java → runelite-api/src/main/java/net/runelite/api/events/StatChanged.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2017, Adam <Adam@sigterm.info> * Copyright (c) 2017-2019, Adam <Adam@sigterm.info>
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@@ -22,20 +22,19 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
package net.runelite.api.events; package net.runelite.api.events;
import lombok.Data; import lombok.Value;
import net.runelite.api.Skill; import net.runelite.api.Skill;
/** /**
* An event where the experience level of a {@link Skill} has been modified. * An event where the experience, level, or boosted level of a {@link Skill} has been modified.
*/ */
@Data @Value
public class ExperienceChanged public class StatChanged
{ {
/** private final Skill skill;
* The modified skill. private final int xp;
*/ private final int level;
private Skill skill; private final int boostedLevel;
} }