Skip to content

Commit

Permalink
refactor: rename all .*Message to .* (removing the Message suffix…
Browse files Browse the repository at this point in the history
… from all the client -> server messages)

This is done to avoid awkward class names (e.g. MessagePublicMessage) as well as avoid already super lengthy names (such as AffinedClanSettingsAddBannedFromChannel); additionally cleans up the various decoders.
  • Loading branch information
Z-Kris committed Apr 4, 2024
1 parent 8b3a70f commit 3f5d520
Show file tree
Hide file tree
Showing 98 changed files with 351 additions and 351 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@ package net.rsprot.protocol.game.incoming.codec.buttons

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.buttons.If1ButtonMessage
import net.rsprot.protocol.game.incoming.buttons.If1Button
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools
import net.rsprot.protocol.util.gCombinedId

@Consistent
public class If1ButtonDecoder : MessageDecoder<If1ButtonMessage> {
public class If1ButtonDecoder : MessageDecoder<If1Button> {
override val prot: ClientProt = GameClientProt.IF_BUTTON

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): If1ButtonMessage {
): If1Button {
val combinedId = buffer.gCombinedId()
return If1ButtonMessage(combinedId)
return If1Button(combinedId)
}
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package net.rsprot.protocol.game.incoming.codec.buttons

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.game.incoming.buttons.If3ButtonMessage
import net.rsprot.protocol.game.incoming.buttons.If3Button
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
Expand All @@ -12,15 +12,15 @@ import net.rsprot.protocol.util.gCombinedId
public class If3ButtonDecoder(
override val prot: GameClientProt,
private val op: Int,
) : MessageDecoder<If3ButtonMessage> {
) : MessageDecoder<If3Button> {
override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): If3ButtonMessage {
): If3Button {
val combinedId = buffer.gCombinedId()
val sub = buffer.g2()
val obj = buffer.g2()
return If3ButtonMessage(
return If3Button(
combinedId,
sub,
obj,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ package net.rsprot.protocol.game.incoming.codec.buttons

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.buttons.IfButtonDMessage
import net.rsprot.protocol.game.incoming.buttons.IfButtonD
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.tools.MessageDecodingTools
import net.rsprot.protocol.util.gCombinedIdAlt2

public class IfButtonDDecoder : MessageDecoder<IfButtonDMessage> {
public class IfButtonDDecoder : MessageDecoder<IfButtonD> {
override val prot: ClientProt = GameClientProt.IF_BUTTOND

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): IfButtonDMessage {
): IfButtonD {
val selectedSub = buffer.g2()
val targetSub = buffer.g2Alt2()
val selectedCombinedId = buffer.gCombinedIdAlt2()
val targetCombinedId = buffer.gCombinedIdAlt2()
val selectedObj = buffer.g2Alt1()
val targetObj = buffer.g2Alt3()
return IfButtonDMessage(
return IfButtonD(
selectedCombinedId,
selectedSub,
selectedObj,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ package net.rsprot.protocol.game.incoming.codec.buttons

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.buttons.IfButtonTMessage
import net.rsprot.protocol.game.incoming.buttons.IfButtonT
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.tools.MessageDecodingTools
import net.rsprot.protocol.util.gCombinedIdAlt2

public class IfButtonTDecoder : MessageDecoder<IfButtonTMessage> {
public class IfButtonTDecoder : MessageDecoder<IfButtonT> {
override val prot: ClientProt = GameClientProt.IF_BUTTONT

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): IfButtonTMessage {
): IfButtonT {
val targetCombinedId = buffer.gCombinedIdAlt2()
val selectedObj = buffer.g2Alt3()
val targetSub = buffer.g2Alt3()
val selectedCombinedId = buffer.gCombinedIdAlt2()
val selectedSub = buffer.g2Alt1()
val targetObj = buffer.g2Alt2()
return IfButtonTMessage(
return IfButtonT(
selectedCombinedId,
selectedSub,
selectedObj,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@ package net.rsprot.protocol.game.incoming.codec.clan

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.clan.AffinedClanSettingsAddBannedFromChannelMessage
import net.rsprot.protocol.game.incoming.clan.AffinedClanSettingsAddBannedFromChannel
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class AffinedClanSettingsAddBannedFromChannelDecoder :
MessageDecoder<AffinedClanSettingsAddBannedFromChannelMessage> {
MessageDecoder<AffinedClanSettingsAddBannedFromChannel> {
override val prot: ClientProt = GameClientProt.AFFINEDCLANSETTINGS_ADDBANNED_FROMCHANNEL

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): AffinedClanSettingsAddBannedFromChannelMessage {
): AffinedClanSettingsAddBannedFromChannel {
val clanId = buffer.g1()
val memberIndex = buffer.g2()
val name = buffer.gjstr()
return AffinedClanSettingsAddBannedFromChannelMessage(
return AffinedClanSettingsAddBannedFromChannel(
name,
clanId,
memberIndex,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ package net.rsprot.protocol.game.incoming.codec.clan

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.clan.AffinedClanSettingsSetMutedFromChannelMessage
import net.rsprot.protocol.game.incoming.clan.AffinedClanSettingsSetMutedFromChannel
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class AffinedClanSettingsSetMutedFromChannelDecoder :
MessageDecoder<AffinedClanSettingsSetMutedFromChannelMessage> {
MessageDecoder<AffinedClanSettingsSetMutedFromChannel> {
override val prot: ClientProt = GameClientProt.AFFINEDCLANSETTINGS_SETMUTED_FROMCHANNEL

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): AffinedClanSettingsSetMutedFromChannelMessage {
): AffinedClanSettingsSetMutedFromChannel {
val clanId = buffer.g1()
val memberIndex = buffer.g2()
val muted = buffer.g1() == 1
val name = buffer.gjstr()
return AffinedClanSettingsSetMutedFromChannelMessage(
return AffinedClanSettingsSetMutedFromChannel(
name,
clanId,
memberIndex,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ package net.rsprot.protocol.game.incoming.codec.clan

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.clan.ClanChannelFullRequestMessage
import net.rsprot.protocol.game.incoming.clan.ClanChannelFullRequest
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class ClanChannelFullRequestDecoder : MessageDecoder<ClanChannelFullRequestMessage> {
public class ClanChannelFullRequestDecoder : MessageDecoder<ClanChannelFullRequest> {
override val prot: ClientProt = GameClientProt.CLANCHANNEL_FULL_REQUEST

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): ClanChannelFullRequestMessage {
): ClanChannelFullRequest {
val clanId = buffer.g1s()
return ClanChannelFullRequestMessage(clanId)
return ClanChannelFullRequest(clanId)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@ package net.rsprot.protocol.game.incoming.codec.clan

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.clan.ClanChannelKickUserMessage
import net.rsprot.protocol.game.incoming.clan.ClanChannelKickUser
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class ClanChannelKickUserDecoder : MessageDecoder<ClanChannelKickUserMessage> {
public class ClanChannelKickUserDecoder : MessageDecoder<ClanChannelKickUser> {
override val prot: ClientProt = GameClientProt.CLANCHANNEL_KICKUSER

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): ClanChannelKickUserMessage {
): ClanChannelKickUser {
val clanId = buffer.g1()
val memberIndex = buffer.g2()
val name = buffer.gjstr()
return ClanChannelKickUserMessage(
return ClanChannelKickUser(
name,
clanId,
memberIndex,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ package net.rsprot.protocol.game.incoming.codec.clan

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.clan.ClanSettingsFullRequestMessage
import net.rsprot.protocol.game.incoming.clan.ClanSettingsFullRequest
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class ClanSettingsFullRequestDecoder : MessageDecoder<ClanSettingsFullRequestMessage> {
public class ClanSettingsFullRequestDecoder : MessageDecoder<ClanSettingsFullRequest> {
override val prot: ClientProt = GameClientProt.CLANSETTINGS_FULL_REQUEST

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): ClanSettingsFullRequestMessage {
): ClanSettingsFullRequest {
val clanId = buffer.g1s()
return ClanSettingsFullRequestMessage(clanId)
return ClanSettingsFullRequest(clanId)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ package net.rsprot.protocol.game.incoming.codec.events

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.events.EventAppletFocusMessage
import net.rsprot.protocol.game.incoming.events.EventAppletFocus
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class EventAppletFocusDecoder : MessageDecoder<EventAppletFocusMessage> {
public class EventAppletFocusDecoder : MessageDecoder<EventAppletFocus> {
override val prot: ClientProt = GameClientProt.EVENT_APPLET_FOCUS

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): EventAppletFocusMessage {
): EventAppletFocus {
val inFocus = buffer.g1() == 1
return EventAppletFocusMessage(inFocus)
return EventAppletFocus(inFocus)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ package net.rsprot.protocol.game.incoming.codec.events

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.events.EventCameraPositionMessage
import net.rsprot.protocol.game.incoming.events.EventCameraPosition
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.tools.MessageDecodingTools

public class EventCameraPositionDecoder : MessageDecoder<EventCameraPositionMessage> {
public class EventCameraPositionDecoder : MessageDecoder<EventCameraPosition> {
override val prot: ClientProt = GameClientProt.EVENT_CAMERA_POSITION

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): EventCameraPositionMessage {
): EventCameraPosition {
val angleX = buffer.g2Alt1()
val angleY = buffer.g2Alt1()
return EventCameraPositionMessage(
return EventCameraPosition(
angleX,
angleY,
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ package net.rsprot.protocol.game.incoming.codec.events

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.events.EventKeyboardMessage
import net.rsprot.protocol.game.incoming.events.EventKeyboard
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.tools.MessageDecodingTools

public class EventKeyboardDecoder : MessageDecoder<EventKeyboardMessage> {
public class EventKeyboardDecoder : MessageDecoder<EventKeyboard> {
override val prot: ClientProt = GameClientProt.EVENT_KEYBOARD

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): EventKeyboardMessage {
): EventKeyboard {
val count = buffer.readableBytes() / 4
val keys = ByteArray(count)
var lastTransmittedKeyPress: Int = -1
Expand All @@ -25,9 +25,9 @@ public class EventKeyboardDecoder : MessageDecoder<EventKeyboardMessage> {
}
keys[i] = key.toByte()
}
return EventKeyboardMessage(
return EventKeyboard(
lastTransmittedKeyPress,
EventKeyboardMessage.KeySequence(keys),
EventKeyboard.KeySequence(keys),
)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ package net.rsprot.protocol.game.incoming.codec.events

import net.rsprot.buffer.JagByteBuf
import net.rsprot.protocol.ClientProt
import net.rsprot.protocol.game.incoming.events.EventMouseClickMessage
import net.rsprot.protocol.game.incoming.events.EventMouseClick
import net.rsprot.protocol.game.incoming.prot.GameClientProt
import net.rsprot.protocol.message.codec.MessageDecoder
import net.rsprot.protocol.metadata.Consistent
import net.rsprot.protocol.tools.MessageDecodingTools

@Consistent
public class EventMouseClickDecoder : MessageDecoder<EventMouseClickMessage> {
public class EventMouseClickDecoder : MessageDecoder<EventMouseClick> {
override val prot: ClientProt = GameClientProt.EVENT_MOUSE_CLICK

override fun decode(
buffer: JagByteBuf,
tools: MessageDecodingTools,
): EventMouseClickMessage {
): EventMouseClick {
val packed = buffer.g2()
val rightClick = packed and 0x1 != 0
val lastTransmittedMouseClick = packed ushr 1
val x = buffer.g2()
val y = buffer.g2()
return EventMouseClickMessage(
return EventMouseClick(
lastTransmittedMouseClick,
rightClick,
x,
Expand Down
Loading

0 comments on commit 3f5d520

Please sign in to comment.