RuneHive-Tarnish
Neural OSRS Enhancement Framework
Loading...
Searching...
No Matches
com.osroyale.content.activity.GroupActivity Class Referenceabstract
Inheritance diagram for com.osroyale.content.activity.GroupActivity:
Collaboration diagram for com.osroyale.content.activity.GroupActivity:

Public Member Functions

void finish ()
void cleanup ()
final boolean isActive ()
int getActiveSize ()
void forEachActivity (BiConsumer< Mob, Activity > activity)
final void addActivity (Mob mob, Activity activity)
final void removeActivity (Mob mob)
final void groupMessage (String message)
Public Member Functions inherited from com.osroyale.content.activity.Activity
 Activity (int cooldown, int instance)
void sequence ()
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

 GroupActivity (int cooldown, int capacity)
void start ()
Protected Member Functions inherited from com.osroyale.content.activity.Activity
final void resetCooldown ()
final void finishCooldown ()
final void pause ()
final boolean isPaused ()
Optional<? extends ActivityListener<? extends Activity > > getListener ()

Protected Attributes

final Map< Mob, Activity > activities

Additional Inherited Members

Static Protected Attributes inherited from com.osroyale.content.activity.Activity
static final int START = 0
static final int FINISH = -1
static final int PAUSE = -2

Detailed Description

A GroupActivity is an extension of Activity that holds a list of active activities.

Author
Michael | Chex

Definition at line 53 of file GroupActivity.java.

Constructor & Destructor Documentation

◆ GroupActivity()

com.osroyale.content.activity.GroupActivity.GroupActivity ( int cooldown,
int capacity )
inlineprotected

Constructs a new GroupActivity object.

Parameters
cooldownthe initial cooldown in ticks

Definition at line 66 of file GroupActivity.java.

Member Function Documentation

◆ addActivity()

final void com.osroyale.content.activity.GroupActivity.addActivity ( Mob mob,
Activity activity )
inline

Adds an activity to the activities group.

Parameters
mobthe mob to add
activitythe mob's activity

Definition at line 127 of file GroupActivity.java.

◆ cleanup()

void com.osroyale.content.activity.GroupActivity.cleanup ( )
inline

Cleans up the activity when finished.

Reimplemented from com.osroyale.content.activity.Activity.

Definition at line 85 of file GroupActivity.java.

◆ finish()

void com.osroyale.content.activity.GroupActivity.finish ( )
inline

Finishes the activity.

Reimplemented from com.osroyale.content.activity.Activity.

Reimplemented in com.osroyale.content.activity.impl.pestcontrol.PestControlGame.

Definition at line 77 of file GroupActivity.java.

◆ forEachActivity()

void com.osroyale.content.activity.GroupActivity.forEachActivity ( BiConsumer< Mob, Activity > activity)
inline

Loops through all the activities.

Parameters
activitythe consumer

Definition at line 117 of file GroupActivity.java.

◆ getActiveSize()

int com.osroyale.content.activity.GroupActivity.getActiveSize ( )
inline

Gets the size of the activities in this group.

Returns
the amount of activities in this group

Definition at line 108 of file GroupActivity.java.

◆ groupMessage()

final void com.osroyale.content.activity.GroupActivity.groupMessage ( String message)
inline

Sends a message to all the players in the group.

Parameters
messagethe message to send

Definition at line 153 of file GroupActivity.java.

◆ isActive()

final boolean com.osroyale.content.activity.GroupActivity.isActive ( )
inline

Checks if this group is active.

Returns
true if there are active activities

Definition at line 99 of file GroupActivity.java.

◆ removeActivity()

final void com.osroyale.content.activity.GroupActivity.removeActivity ( Mob mob)
inline

Removes an activity from the activities group.

Parameters
mobthe mob that owns the activity

Definition at line 139 of file GroupActivity.java.

◆ start()

void com.osroyale.content.activity.GroupActivity.start ( )
inlineprotected

Starts the next activity stage.

Reimplemented from com.osroyale.content.activity.Activity.

Reimplemented in com.osroyale.content.activity.lobby.LobbyNode.

Definition at line 72 of file GroupActivity.java.

Member Data Documentation

◆ activities

final Map<Mob, Activity> com.osroyale.content.activity.GroupActivity.activities
protected

A map of activities that handles each mob individually.

Definition at line 56 of file GroupActivity.java.

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