org.osbot.rs07.api.ai.activity

Class Location

java.lang.Object

org.osbot.rs07.api.map.Area

org.osbot.rs07.api.ai.activity.Location

public class Location
extends Area

Extension on the Area functionality to provide activity configurations with possible locations to execute

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_POPULATION_IMPACT

Constructor Summary

Constructors

Constructor and Description
Location(java.lang.String name, Area area, Requirement... requirements) Constructor
Location(java.lang.String name, int[][] positions, Requirement... requirements) Constructor
Location(java.lang.String name, int x1, int y1, int x2, int y2, Requirement... requirements) Constructor

Method Summary

Modifier and Type	Method and Description
AccountPrerequisites	getAccountPrerequisites() Gets the account prerequisites required to access this location
java.lang.String	getName() Gets the name of the location
float	getPopulationImpact() Gets how much the population at the locations affect the outcome.
Requirement[]	getRequirements() Gets the requirements to access the location
Location	setAccountPrerequisites(AccountPrerequisites accountPrerequisites) Sets the account prerequisites and returns this instance
Location	setPopulationImpact(float populationImpact) Sets the population impact and returns this instance

Methods inherited from class org.osbot.rs07.api.map.Area

contains, contains, contains, contains, getCentralPosition, getPlane, getPolygon, getPositions, getRandomPosition, setPlane, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POPULATION_IMPACT

public static final float DEFAULT_POPULATION_IMPACT

See Also:

Constant Field Values

Constructor Detail

Location

public Location(java.lang.String name,
                int[][] positions,
                Requirement... requirements)

Constructor

Parameters:

name - The name of the location

positions - The positions of the location

requirements - The requirements to access the location

Location

public Location(java.lang.String name,
                Area area,
                Requirement... requirements)

Constructor

Parameters:

name - The name of the location

area - The area of the location

requirements - The requirements to access the location

Location

public Location(java.lang.String name,
                int x1,
                int y1,
                int x2,
                int y2,
                Requirement... requirements)

Constructor

Parameters:

name - The name of the location

x1 - Top left x

y1 - Top left y

x2 - Bottom right x

y2 - Bottom right y

requirements - The requirements to access the location

Method Detail

getName

public java.lang.String getName()

Gets the name of the location

Returns:

The name of the location

getRequirements

public Requirement[] getRequirements()

Gets the requirements to access the location

Returns:

The requirements to access the location

getPopulationImpact

public float getPopulationImpact()

Gets how much the population at the locations affect the outcome. When not provided, the default value is This value is expected to be between 0.0F and 1.0F, where 0.0F means no impact from the population and 1.0F means the highest amount of impact from the population

This value is multiplied with the configuration impact to get a final impact per location. See ActivityConfiguration.Builder.setPopulationImpact(float) for more details.

Returns:

How much the population at the locations affect the outcome

getAccountPrerequisites

public AccountPrerequisites getAccountPrerequisites()

Gets the account prerequisites required to access this location

Returns:

The account prerequisites required to access this location

setPopulationImpact

public Location setPopulationImpact(float populationImpact)

Sets the population impact and returns this instance

Parameters:

populationImpact - The population impact

Returns:

This instance

setAccountPrerequisites

public Location setAccountPrerequisites(AccountPrerequisites accountPrerequisites)

Sets the account prerequisites and returns this instance

Parameters:

accountPrerequisites - The account prerequisites

Returns:

This instance