osrs-226-model/net.rsprot.protocol.game.outgoing.social/UpdateFriendList/OnlineFriend

OnlineFriend

class OnlineFriend : UpdateFriendList.Friend

Online friends are friends who are currently logged into the game.

Constructors

constructor(added: Boolean, name: String, previousName: String?, worldId: Int, rank: Int, properties: Int, notes: String, worldName: String, platform: Int, worldFlags: Int)

Properties

added

open override val added: Boolean

whether the friend was just added to the friend list, or if it's an initial load. For initial loads, the client skips existing friend checks.

name

open override val name: String

the display name of the friend

notes

open override val notes: String

the notes on that friend. None of the clients use this value.

platform

val platform: Int

the id of the client the friend is logged into. Current known values include 0 for RuneScape 3, 4 for RS3's lobby (presumably), and 8 for OldSchool RuneScape. The OldSchool clients do not utilize this, its purpose is to prevent sending quick-chat messages from RuneScape 3 over to OldSchool RuneScape, as it does not support quick chat functionality.

previousName

open override val previousName: String?

the previous display name of the friend, if they had one. If not, set it to null.

properties

open override val properties: Int

a set of bitpacked properties; currently, the client only checks for two properties - PROPERTY_REFERRED and PROPERTY_REFERRER. These properties only affect the ordering of friends in the player's friend list.

rank

open override val rank: Int

the friend's current rank, used to determine the chat icon

worldFlags

val worldFlags: Int

the flags of the world the friend is logged into.

worldId

open override val worldId: Int

the world that the friend is logged into

worldName

val worldName: String

the name of the world the player is logged into, e.g. "Old School 35" for world 335 in OldSchool RuneScape.