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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

//! Palette related packets. \[0x21\]
use crate::fixed_types::FixedVec;

use super::{HelperReadWrite, PacketReadWrite};

// ----------------------------------------------------------------
// Palette packets
// ----------------------------------------------------------------

/// (0x21, 0x01) Load Palettes.
///
/// (S -> C) Sent when a player starts a game or when a palette is updated.
///
/// Response to:
/// [`crate::protocol::Packet::StartGame`],
/// [`crate::protocol::Packet::UpdatePalette`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x01)]
pub struct LoadPalettePacket {
    /// Current palette index.
    pub cur_palette: u32,
    /// Current subpalette index.
    pub cur_subpalette: u32,
    /// Current book index.
    pub cur_book: u32,
    /// Palettes in the first book.
    pub palettes: [WeaponPalette; 6],
    /// Subpalettes in the first book.
    #[SeekAfter(0x240)] // maybe other books
    pub subpalettes: [SubPalette; 6],
}

/// (0x21, 0x03) Full Palette Info.
///
/// (S -> C) Sent in response to the request.
///
/// Response to:
/// [`crate::protocol::Packet::FullPaletteInfoRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x03)]
pub struct FullPaletteInfoPacket {
    // from packet 0x21, 0x01
    /// Current palette index.
    pub cur_palette: u32,
    /// Current subpalette index.
    pub cur_subpalette: u32,
    /// Current book index.
    pub cur_book: u32,
    /// Palettes in the first book.
    pub palettes: [WeaponPalette; 6],
    /// Subpalettes in the first book.
    pub subpalettes: [SubPalette; 6],
    #[Seek(0x240)] // maybe other books
    // from packet 0x21, 0x0F
    /// Default photon arts (?).
    #[SeekAfter(0x240)] // padding??
    pub default_pa: FixedVec<0x1A0, u32>,
}

/// (0x21, 0x04) Set Active Palette.
///
/// (C -> S) Sent when a player changes their active palette.
///
/// Respond with:
/// [`crate::protocol::Packet::EquipedWeapon`],
/// [`crate::protocol::Packet::ChangeWeaponPalette`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x04)]
pub struct SetPalettePacket {
    /// Selected palette index.
    pub palette: u32,
    pub unk: u32,
}

/// (0x21, 0x05) Update Subpalette.
///
/// (C -> S) Sent when a player updates their subpalette (i.e. changes installed items).
///
/// Respond with:
/// [`crate::protocol::Packet::LoadPalette`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x05)]
pub struct UpdateSubPalettePacket {
    /// New subpalettes.
    pub subpalettes: [SubPalette; 6],
    pub unk: FixedVec<0x90, u32>,
    /// Current subpalette index.
    pub cur_subpalette: u32,
    /// Current book index.
    pub cur_book: u32,
}

/// (0x21, 0x06) Update Palette.
///
/// (C -> S) Sent when a player updates their palette (i.e. changes installed weapons).
///
/// Respond with:
/// [`crate::protocol::Packet::LoadPalette`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x06)]
pub struct UpdatePalettePacket {
    /// Current palette index.
    pub cur_palette: u32,
    /// New palettes.
    pub palettes: [WeaponPalette; 6],
}

/// (0x21, 0x08) Set Active Subpalette.
///
/// (C -> S) Sent when a player changes their active subpalette.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x08)]
pub struct SetSubPalettePacket {
    /// New subpalette index.
    pub subpalette: u32,
}

/// (0x21, 0x0A) Set Default Photon Arts (?)
///
/// (C -> S) Reasons for sending currently unknown.
///
/// Respond with: [`crate::protocol::Packet::NewDefaultPAs`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x0A)]
pub struct SetDefaultPAsPacket {
    pub default: FixedVec<0x1A0, u32>,
}

/// (0x21, 0x0F) New Default Photon Arts (?)
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::SetDefaultPAs`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, PacketReadWrite)]
#[Id(0x21, 0x0F)]
pub struct NewDefaultPAsPacket {
    #[SeekAfter(0x240)] // padding??
    pub default: FixedVec<0x1A0, u32>,
}

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

/// Weapon in the palette.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct WeaponPalette {
    /// Item UUID.
    pub uuid: u64,
    pub unk1: u32,
    pub unk2: PalettePA,
    pub unk3: PalettePA,
    pub unk4: PalettePA,
    pub unk: [u32; 3],
    /// Pet ID (for summoner).
    pub pet_id: u32,
    /// Weapon skills.
    pub skills: [PalettePA; 6],
}

/// Subpalette definition.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct SubPalette {
    /// Items in the subpalette.
    pub items: [PalettePA; 12],
}

/// Photon Art in the palette.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct PalettePA {
    /// PA ID.
    pub id: u8,
    /// PA category.
    pub category: u8,
    pub unk: u8,
    /// PA level.
    pub level: u8,
}