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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

//! Symbol Art related packets. \[0x2F\]
use crate::fixed_types::Bytes;

use super::{HelperReadWrite, MessageChannel, ObjectHeader, PacketReadWrite};

// ----------------------------------------------------------------
// Symbol Art packets
// ----------------------------------------------------------------

/// (0x2F, 0x00) Request Symbol Art Data (client).
///
/// (C -> S) Sent when the client encounters an unknown symbol art and wants to receive it's data.
///
/// Respond with: [`crate::protocol::Packet::SymbolArtClientData`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x00)]
pub struct SymbolArtClientDataRequestPacket {
    /// Symbol Art UUID.
    pub uuid: u128,
}

/// (0x2F, 0x01) Request Symbol Art Data (server).
///
/// (S -> C) Sent when the server encounters an unknown symbol art and wants to receive it's data.
///
/// Respond with: [`crate::protocol::Packet::SymbolArtData`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x01)]
pub struct SymbolArtDataRequestPacket {
    /// Symbol Art UUID.
    pub uuid: u128,
}

/// (0x2F, 0x02) Symbol Art Data (serverbound).
///
/// (C -> S) Sent in response to the reqeust
///
/// Response to: [`crate::protocol::Packet::SymbolArtDataRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x02)]
#[Flags(Flags::PACKED)]
#[Magic(0x4B58, 0x76)]
pub struct SymbolArtDataPacket {
    /// Symbol Art UUID.
    pub uuid: u128,
    /// Symbol Art data.
    pub data: Bytes,
    /// Symbol Art name.
    pub name: String,
}

/// (0x2F, 0x03) Symbol Art Data (clientbound).
///
/// (S -> C) Sent in response to the reqeust
///
/// Response to: [`crate::protocol::Packet::SymbolArtClientDataRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x03)]
#[Flags(Flags::PACKED)]
#[Magic(0xD116, 0xC1)]
pub struct SymbolArtClientDataPacket {
    /// Symbol Art UUID.
    pub uuid: u128,
    /// Symbol Art data.
    pub data: Bytes,
}

/// (0x2F, 0x04) Change Symbol Art Slot.
///
/// (C -> S) Sent when the client puts a new symbol art in a save slot.
///
/// Respond with: [`crate::protocol::Packet::SymbolArtResult`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x04)]
#[Flags(Flags::PACKED)]
#[Magic(0x56D3, 0x0C)]
pub struct ChangeSymbolArtPacket {
    /// Symbol Art UUIDs and slot indexes.
    pub uuids: Vec<SlottedSymbolArt>,
}

/// (0x2F, 0x05) Change Symbol Art Slot Result.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::ChangeSymbolArt`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x05)]
#[Flags(Flags::PACKED)]
#[Magic(0xDC91, 0x57)]
pub struct SymbolArtResultPacket {
    pub unk1: u32,
    pub uuids: Vec<u128>,
}

/// (0x2F, 0x07) Saved Symbol Art List.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::SymbolArtListRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x07)]
#[Flags(Flags::PACKED)]
#[Magic(0xE80C, 0xED)]
pub struct SymbolArtListPacket {
    /// Player object.
    pub object: ObjectHeader,
    /// Currenly selected character ID.
    pub character_id: u32,
    /// Saved UUIDs.
    pub uuids: Vec<u128>,
}

/// (0x2F, 0x08) Send Symbol Art.
///
/// (C -> S) Sent when a client sends a symbol art.
///
/// Respond with: [`crate::protocol::Packet::ReceiveSymbolArt`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x08)]
#[Flags(Flags::OBJECT_RELATED)]
pub struct SendSymbolArtPacket {
    /// Sender object (unset).
    pub object: ObjectHeader,
    /// Symbol Art UUID.
    pub uuid: u128,
    /// Symbol Art channel.
    pub area: MessageChannel,
    pub unk1: u8,
    pub unk2: u16,
    pub unk3: u32,
}

/// (0x2F, 0x09) Received Symbol Art.
///
/// (S -> C) Sent when a client receives a symbol art.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x2F, 0x09)]
pub struct ReceiveSymbolArtPacket {
    /// Sender object.
    pub object: ObjectHeader,
    /// Symbol Art UUID.
    pub uuid: u128,
    /// Symbol Art channel.
    pub area: MessageChannel,
    pub unk1: u8,
    pub unk2: u16,
    pub unk3: u32,
}

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

/// Symbol Art in a saved SA list.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Copy, Default, PartialEq, HelperReadWrite)]
pub struct SlottedSymbolArt {
    /// UUID of the Symbol Art.
    pub uuid: u128,
    /// Slot index.
    pub slot: u32,
}