pso2packetlib 0.5.0

A library for working with the PSO2 network protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! Mail related packets. \[0x1A\]
use crate::fixed_types::FixedString;

use super::{HelperReadWrite, PacketReadWrite};
use std::time::Duration;

// ----------------------------------------------------------------
// Mail packets
// ----------------------------------------------------------------

/// (0x1A, 0x00) Mail List Request.
///
/// (C -> S) Sent when the client wants to get a list of mail messages.
///
/// Respond with: [`crate::protocol::Packet::MailList`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x00)]
pub struct MailListRequestPacket {
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u32,
}

/// (0x1A, 0x01) Mail List.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::MailListRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x01)]
#[Flags(Flags::PACKED)]
#[Magic(0x36A1, 0xBF)]
pub struct MailListPacket {
    pub unk1: u16,
    pub unk2: u16,
    pub unk3: u16,
    pub unk4: u16,
    pub unk5: [u8; 4],
    pub unk6: u32,
    /// Player name (?).
    pub name: String,
    /// Character name (?).
    pub nickname: String,
    /// Mail headers.
    pub headers: Vec<MailHeader>,
}

/// (0x1A, 0x02) Delete Mail Request.
///
/// (C -> S) Sent when the client wants to delete mail messages.
///
/// Respond with: [`crate::protocol::Packet::DeletedMail`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x02)]
#[Flags(Flags::PACKED)]
#[Magic(0xBC5F, 0x0B)]
pub struct DeleteMailRequestPacket {
    /// IDs of messages to delete.
    pub ids: Vec<MailId>,
}

/// (0x1A, 0x03) Deleted Mail.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::DeleteMailRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x03)]
#[Flags(Flags::PACKED)]
#[Magic(0x421C, 0x56)]
pub struct DeletedMailPacket {
    /// Deleted messages IDs.
    pub ids: Vec<MailId>,
    pub unk: u32,
}

/// (0x1A, 0x06) Mail Body Request.
///
/// (C -> S) Sent when the client wants to get a body of mail.
///
/// Respond with: [`crate::protocol::Packet::MailBody`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x06)]
pub struct MailBodyRequestPacket {
    /// Message ID.
    pub id: MailId,
}

/// (0x1A, 0x07) Mail Body.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::MailBodyRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x1A, 0x07)]
#[Flags(Flags::PACKED)]
#[Magic(0x5913, 0x82)]
pub struct MailBodyPacket {
    /// Message ID.
    pub id: MailId,
    /// Message body.
    pub message: String,
    pub unk3: u32,
}

// ----------------------------------------------------------------
// Additional structs
// ----------------------------------------------------------------

/// Mail ID with extra information.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct MailId {
    /// Mail ID.
    pub mail_id: u32,
    pub unk1: u32,
    pub unk2: u32,
}

/// Mail header.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct MailHeader {
    /// Mail ID.
    pub mail_id: u32,
    pub unk2: u32,
    /// Sender player ID (?).
    pub user_id: u32,
    pub unk3: [u8; 0x14],
    pub unk4: u32,
    pub unk5: u32,
    /// Mail receive timestamp.
    pub receive_time: Duration,
    pub unk6: u32,
    /// Sender name.
    pub sender: FixedString<0x22>,
    /// Mail subject.
    pub subject: FixedString<0x2A>,
}