Package com.osrsbots.orb.api.interactables.types

Class RSPlayer

java.lang.Object

com.osrsbots.orb.api.interactables.types.RSPlayer

All Implemented Interfaces:

RSActor

public class RSPlayer
extends java.lang.Object
implements RSActor

Constructor Summary

Constructors

Constructor	Description
RSPlayer(net.runelite.api.Player composition)

Method Summary

Modifier and Type	Method	Description
boolean	doAction(java.lang.String option)
boolean	doAction(net.runelite.api.MenuAction type, java.lang.String option)
int[]	getColors()
@Nullable net.runelite.api.ColorTextureOverride[]	getColorTextureOverrides()
int	getCombatLevel()
int	getEquipmentId(net.runelite.api.kit.KitType kt)
int[]	getEquipmentIds()
int	getGender()
int	getId()
int	getKitId(net.runelite.api.kit.KitType kt)
@Nullable java.lang.String	getName()
@Nullable net.runelite.api.HeadIcon	getOverheadIcon()
@Nullable SkullIcon	getSkullIcon()
int	getTeam()
boolean	interact(@Nullable net.runelite.api.MenuAction type, java.lang.String option)
boolean	interact(java.lang.String option)
boolean	isClanMember()
boolean	isDead()
boolean	isFighting(java.lang.String targetName)
boolean	isFriend()
boolean	isFriendsChatMember()
boolean	isInCombat()
boolean	isInteractingWith(java.lang.String targetName)
boolean	isMoving()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.osrsbots.orb.api.interactables.types.RSActor

distanceToPlayer, getAnimation, getAnimationFrame, getClickbox, getCurrentOrientation, getHealthRatio, getHealthScale, getIdlePoseAnimation, getIdleRotateLeft, getIdleRotateRight, getInteracting, getLocalLocation, getMinimapLocation, getModel, getOrientation, getOverheadCycle, getOverheadText, getPoseAnimation, getPoseAnimationFrame, getRunAnimation, getSpotAnims, getWalkAnimation, getWalkRotate180, getWalkRotateLeft, getWalkRotateRight, getWorldArea, getWorldLocation, getWorldView, hasSpotAnim, highlight, hover, isInteractable, isInteracting, isReachable, useWith

Constructor Detail

RSPlayer

public RSPlayer(@Nonnull
                net.runelite.api.Player composition)

Method Detail

doAction

public boolean doAction(@Nonnull
                        java.lang.String option)

Specified by:

doAction in interface RSActor

doAction

public boolean doAction(@Nonnull
                        net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

Specified by:

doAction in interface RSActor

interact

public boolean interact(@Nonnull
                        java.lang.String option)

Specified by:

interact in interface RSActor

interact

public boolean interact(@Nullable
                        @Nullable net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

Specified by:

interact in interface RSActor

isInteractingWith

public boolean isInteractingWith(@Nonnull
                                 java.lang.String targetName)

Specified by:

isInteractingWith in interface RSActor

isMoving

public boolean isMoving()

Specified by:

isMoving in interface RSActor

getOverheadIcon

@Nullable
public @Nullable net.runelite.api.HeadIcon getOverheadIcon()

getSkullIcon

@Nullable
public @Nullable SkullIcon getSkullIcon()

getName

@Nullable
public @Nullable java.lang.String getName()

Specified by:

getName in interface RSActor

getColorTextureOverrides

@Nullable
public @Nullable net.runelite.api.ColorTextureOverride[] getColorTextureOverrides()

getId

public int getId()

isDead

public boolean isDead()

Specified by:

isDead in interface RSActor

isInCombat

public boolean isInCombat()

isFighting

public boolean isFighting(@Nonnull
                          java.lang.String targetName)

getCombatLevel

public int getCombatLevel()

Specified by:

getCombatLevel in interface RSActor

getTeam

public int getTeam()

isFriendsChatMember

public boolean isFriendsChatMember()

isFriend

public boolean isFriend()

isClanMember

public boolean isClanMember()

getGender

public int getGender()

getColors

public int[] getColors()

getEquipmentIds

public int[] getEquipmentIds()

getEquipmentId

public int getEquipmentId(net.runelite.api.kit.KitType kt)

getKitId

public int getKitId(net.runelite.api.kit.KitType kt)