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

//! Collection Folder related packets. \[0x42\]

use std::time::Duration;

use super::{HelperReadWrite, ItemData, ItemId, PacketReadWrite};
use crate::fixed_types::{FixedString, FixedVec};

// ----------------------------------------------------------------
// Collection Folder related packets
// ----------------------------------------------------------------

/// (0x42, 0x01) Currently Distibuted Collection Folder List.
///
/// (S -> C) Sent in response to the list request.
///
/// Response to: [`crate::protocol::Packet::GetCollectionList`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x01)]
#[Flags(Flags::PACKED)]
#[Magic(0xD93F, 0x5B)]
pub struct CollectionNameListPacket {
    pub folders: Vec<CollectionFolderName>,
    pub unk: u32,
}

/// (0x42, 0x02) Get Collection Folder Rewards List Request.
///
/// (C -> S) Sent when the client selects a collection folder to receive a list of rewards.
///
/// Respond with: [`crate::protocol::Packet::FolderItemList`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x02)]
pub struct GetFolderItemListPacket {
    /// Requested folder ID.
    pub folder_id: u32,
}

/// (0x42, 0x03) Collection Folder Reward List.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::GetFolderItemList`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x03)]
#[Flags(Flags::PACKED)]
#[Magic(0xE4BA, 0xF1)]
pub struct FolderItemListPacket {
    pub items: Vec<CollectionFolderItem>,
    pub unk: u32,
}

/// (0x42, 0x05) Active Sheets List.
///
/// (S -> C) Sent in response to the request.
///
/// Response to: [`crate::protocol::Packet::GetActiveSheets`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x05)]
#[Flags(Flags::PACKED)]
#[Magic(0xF035, 0x87)]
pub struct ActiveSheetsPacket {
    pub items: Vec<CollectionFolderItem>,
    pub progress: Vec<CollectionFolderProgress>,
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u32,
}

/// (0x42, 0x06) Claim Collection Sheet Request.
///
/// (C -> S) Sent when the client wants to claim a collection sheet.
///
/// Respond with: [`crate::protocol::Packet::ClaimSheetResult`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x06)]
pub struct ClaimSheetRequestPacket {
    /// Requested folder ID.
    pub folder_id: u32,
    /// Requested reward ID.
    pub reward_id: u32,
}

/// (0x42, 0x07) Claim Collection Sheet Result.
///
/// (S -> C) Sent in response to request.
///
/// Response to: [`crate::protocol::Packet::ClaimSheetRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x07)]
pub struct ClaimSheetResultPacket {
    pub unk: u32,
}

/// (0x42, 0x0F) Claim Collection Sheet Action (?).
///
/// (S -> C) Sent in response to request.
///
/// Response to: [`crate::protocol::Packet::ClaimSheetRequest`]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x42, 0x0F)]
#[Flags(Flags::PACKED)]
#[Magic(0x299E, 0x76)]
pub struct ClaimSheetActionPacket {
    pub action: String,
    pub folder_name: String,
    pub reward: String,
}

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

/// Entry in the list of collection folders.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct CollectionFolderName {
    pub folder_id: u32,
    pub folder_name: FixedString<0x20>,
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u16,
    pub unk4: u16,
    pub unk5: u32,
}

/// Reward item from collection folder.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Default, Debug, Clone, PartialEq, HelperReadWrite)]
pub struct CollectionFolderItem {
    /// ID of the associated collection folder.
    pub folder_id: u32,
    /// ID of this reward.
    pub reward_id: u32,
    pub unk1: FixedVec<10, u16>,
    /// Received item.
    pub target_item: ItemData,
    /// Required items.
    pub required_items: FixedVec<8, CollectionReqItem>,
    pub unk2: FixedVec<14, u16>,
}

/// Required item for a reward item.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Default, Debug, Clone, PartialEq, HelperReadWrite)]
pub struct CollectionReqItem {
    pub item_id: ItemId,
    pub unk1: FixedVec<60, u16>,
    pub unk2: FixedVec<52, u16>,
}

/// Current collection sheet progress.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Default, Debug, Clone, PartialEq, HelperReadWrite)]
pub struct CollectionFolderProgress {
    /// ID of the associated collection folder.
    pub folder_id: u32,
    /// ID of the associated reward.
    pub reward_id: u32,
    pub unk: FixedVec<0x1B, u32>,
    pub start_time: Duration,
}