Inheritance diagram for com.osroyale.content.activity.Activity:

Public Member Functions
	Activity (int cooldown, int instance)
void	sequence ()
abstract void	finish ()
abstract void	cleanup ()
void	update ()
void	onLogout (Player player)
void	onDeath (Mob mob)
void	setPanel (Activity_Panel panel)
Optional< Activity_Panel >	getPanel ()
void	onRegionChange (Player player)
boolean	canTeleport (Player player)
void	add (Mob mob)
void	remove (Mob mob)
void	removeAll (Mob... mobs)
void	setPause (boolean pause)
void	cooldown (int cooldown)
int	getInstance ()
int	getTicks ()

Protected Member Functions
abstract void	start ()
final void	resetCooldown ()
final void	finishCooldown ()
final void	pause ()
final boolean	isPaused ()
Optional<? extends ActivityListener<? extends Activity > >	getListener ()

Static Protected Attributes
static final int	START = 0
static final int	FINISH = -1
static final int	PAUSE = -2

Detailed Description

A Activity object constructs an in-game activity and sequences it through the start() and finish() methods with a cooldown set in game ticks.

Author: Michael | Chex

Definition at line 68 of file Activity.java.

Constructor & Destructor Documentation

◆ Activity()

com.osroyale.content.activity.Activity.Activity	(	int	cooldown,
		int	instance )

inline

Constructs a new SequencedMinigame object.

Definition at line 92 of file Activity.java.

Member Function Documentation

◆ add()

void com.osroyale.content.activity.Activity.add ( Mob mob )

inline

Adds a mob to the activity.

Reimplemented in com.osroyale.content.activity.impl.kraken.KrakenActivity.

Definition at line 235 of file Activity.java.

◆ canTeleport()

boolean com.osroyale.content.activity.Activity.canTeleport ( Player player )

inline

Called when the player attempts to teleport.

Definition at line 230 of file Activity.java.

◆ cleanup()

abstract void com.osroyale.content.activity.Activity.cleanup ( )

abstract

Cleans up the activity when finished.

◆ cooldown()

void com.osroyale.content.activity.Activity.cooldown ( int cooldown )

inline

Applies a cooldown.

Reimplemented in com.osroyale.game.action.impl.TutorialActivity.

Definition at line 281 of file Activity.java.

◆ finish()

abstract void com.osroyale.content.activity.Activity.finish ( )

abstract

Finishes the activity.

◆ finishCooldown()

final void com.osroyale.content.activity.Activity.finishCooldown ( )

inlineprotected

Sets the cooldown flag to FINISH.

Definition at line 286 of file Activity.java.

◆ getInstance()

int com.osroyale.content.activity.Activity.getInstance ( )

inline

Gets this activity's instance level.

Definition at line 305 of file Activity.java.

◆ getListener()

Optional<? extends ActivityListener<? extends Activity > > com.osroyale.content.activity.Activity.getListener ( )

inlineprotected

Gets an Optional of the ActivityListener for this activity.

Reimplemented in com.osroyale.content.activity.impl.duelarena.DuelArenaActivity, com.osroyale.content.activity.impl.fightcaves.FightCaves, com.osroyale.content.activity.impl.godwars.GodwarsActivity, com.osroyale.content.activity.impl.kraken.KrakenActivity, com.osroyale.content.activity.impl.pestcontrol.PestControlGame, com.osroyale.content.activity.impl.warriorguild.WarriorGuild, com.osroyale.content.activity.impl.zulrah.ZulrahActivity, and com.osroyale.content.activity.inferno.Inferno.

Definition at line 319 of file Activity.java.

◆ getPanel()

Optional< Activity_Panel > com.osroyale.content.activity.Activity.getPanel ( )

inline

Gets an optional of the activity panel.

Definition at line 220 of file Activity.java.

◆ getTicks()

int com.osroyale.content.activity.Activity.getTicks ( )

inline

Gets the current ticks.

Definition at line 314 of file Activity.java.

◆ isPaused()

final boolean com.osroyale.content.activity.Activity.isPaused ( )

inlineprotected

Checks if the cooldown is paused.

Definition at line 296 of file Activity.java.

◆ onDeath()

void com.osroyale.content.activity.Activity.onDeath ( Mob mob )

inline

Called when the player die

Definition at line 194 of file Activity.java.

◆ onLogout()

void com.osroyale.content.activity.Activity.onLogout ( Player player )

inline

Called when the player logs out.

Definition at line 189 of file Activity.java.

◆ onRegionChange()

void com.osroyale.content.activity.Activity.onRegionChange ( Player player )

inline

Called when the player changes region.

Definition at line 225 of file Activity.java.

◆ pause()

final void com.osroyale.content.activity.Activity.pause ( )

inlineprotected

Sets the cooldown flag to PAUSE.

Definition at line 291 of file Activity.java.

◆ remove()

void com.osroyale.content.activity.Activity.remove ( Mob mob )

inline

Removes a mob from the activity.

Reimplemented in com.osroyale.content.activity.impl.kraken.KrakenActivity.

Definition at line 247 of file Activity.java.

◆ removeAll()

void com.osroyale.content.activity.Activity.removeAll ( Mob... mobs )

inline

Removes all mobs from the activity.

Definition at line 262 of file Activity.java.

◆ resetCooldown()

final void com.osroyale.content.activity.Activity.resetCooldown ( )

inlineprotected

Resets the remaining ticks to the cached cooldown ticks.

Definition at line 276 of file Activity.java.

◆ sequence()

void com.osroyale.content.activity.Activity.sequence ( )

inline

Sequences the activity.

Reimplemented in com.osroyale.content.activity.impl.duelarena.DuelArenaActivity, com.osroyale.content.activity.impl.pestcontrol.PestControlGame, and com.osroyale.content.activity.impl.warriorguild.WarriorGuild.

Definition at line 156 of file Activity.java.

◆ setPanel()

void com.osroyale.content.activity.Activity.setPanel ( Activity_Panel panel )

inline

Sets the activity panel.

Definition at line 215 of file Activity.java.

◆ setPause()

void com.osroyale.content.activity.Activity.setPause ( boolean pause )

inline

Sets the pause state of the activity.

Definition at line 271 of file Activity.java.

◆ start()

abstract void com.osroyale.content.activity.Activity.start ( )

abstractprotected

Starts the next activity stage.

◆ update()

void com.osroyale.content.activity.Activity.update ( )

inline

The update method.

Reimplemented in com.osroyale.content.activity.impl.barrows.Barrows, com.osroyale.content.activity.impl.duelarena.DuelArenaActivity, com.osroyale.content.activity.impl.fightcaves.FightCaves, com.osroyale.content.activity.impl.godwars.GodwarsActivity, com.osroyale.content.activity.impl.magearena.MageArena, com.osroyale.content.activity.impl.recipefordisaster.RecipeForDisaster, com.osroyale.content.activity.impl.warriorguild.WarriorGuild, and com.osroyale.content.activity.inferno.Inferno.

Definition at line 182 of file Activity.java.

Member Data Documentation

◆ FINISH

final int com.osroyale.content.activity.Activity.FINISH = -1

staticprotected

The 'finish' cooldown id.

Definition at line 74 of file Activity.java.

◆ PAUSE

final int com.osroyale.content.activity.Activity.PAUSE = -2

staticprotected

The 'pause' cooldown id.

Definition at line 77 of file Activity.java.

◆ START

final int com.osroyale.content.activity.Activity.START = 0

staticprotected

The 'start' cooldown id.

Definition at line 71 of file Activity.java.

The documentation for this class was generated from the following file:

osroyale/content/activity/Activity.java

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Activity()

Member Function Documentation

◆ add()

◆ canTeleport()

◆ cleanup()

◆ cooldown()

◆ finish()

◆ finishCooldown()

◆ getInstance()

◆ getListener()

◆ getPanel()

◆ getTicks()

◆ isPaused()

◆ onDeath()

◆ onLogout()

◆ onRegionChange()

◆ pause()

◆ remove()

◆ removeAll()

◆ resetCooldown()

◆ sequence()

◆ setPanel()

◆ setPause()

◆ start()

◆ update()

Member Data Documentation

◆ FINISH

◆ PAUSE

◆ START