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

//! Emergency related packets. \[0x15\]
use super::{HelperReadWrite, ObjectHeader, PacketReadWrite};
use crate::{fixed_types::{FixedBytes, FixedVec}, AsciiString};

// ----------------------------------------------------------------
// Emergency packets
// ----------------------------------------------------------------

/// (0x15, 0x02) Start Emergency (broadcast).
///
/// (S -> C) Sent when an emergency trial has started.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x02)]
#[Magic(0x080B, 0x77)]
#[Flags(Flags::PACKED)]
pub struct SpawnEmergencyPacket {
    /// Emergency object.
    pub object: ObjectHeader,
    /// Trial string ID.
    pub trial_id: AsciiString,
    pub unk1: FixedBytes<0x40>,
    pub unk2: AsciiString,
    pub unk3: Vec<Unk1502_1>,
    pub unk4: AsciiString,
    pub unk5: Vec<Unk1502_1>,
    /// Trial fail conditions.
    pub fail_conds: FixedVec<3, EmergencyCondition>,
    /// Trial pass conditions.
    pub pass_conds: FixedVec<2, EmergencyCondition>,
    pub unk8: u32,
    pub unk9: u32,
    pub unk10: AsciiString,
    pub unk11: Vec<Unk1502_1>,
    pub unk12: AsciiString,
    pub unk13: Vec<Unk1502_1>,
    pub unk14: u32,
    pub unk15: FixedBytes<0x20>,
    pub unk16: u32,
    pub unk17: u32,
    pub unk18: AsciiString,
    pub unk19: Vec<Unk1502_1>,
    pub unk20: Vec<Unk1502_3>,
    pub unk21: u32,
}

/// (0x15, 0x03) End Emergency (broadcast).
///
/// (S -> C) Sent when an emergency trial has ended.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x03)]
#[Flags(Flags::PACKED)]
#[Magic(0x8DC9, 0xC2)]
pub struct EmergencyEndPacket {
    /// Emergency object.
    pub object: ObjectHeader,
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u32,
    pub unk4: u32,
    pub unk5: FixedBytes<0x1C>,
    pub unk6: u32,
    pub unk7: AsciiString,
    pub unk8: Vec<Unk1502_1>,
    pub unk9: AsciiString,
    pub unk10: Vec<Unk1502_1>,
}

/// (0x15, 0x05) Emergency Progress (broadcast).
///
/// (S -> C) Sent when an emergency trial progress is updated.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x05)]
pub struct EmergencyProgressPacket {
    /// Emergency object.
    pub emergency: ObjectHeader,
    pub unk2: u32,
    pub unk3: u32,
    pub done: u32,
    pub unk5: u32,
}

/// (0x15, 0x08) Unknown.
///
/// (S -> C)
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x08)]
pub struct Unk1508Packet {
    /// Emergency object.
    pub emergency: ObjectHeader,
    pub unk2: u32,
    pub unk3: u32,
}

/// (0x15, 0x11) Available Emergencies (?).
///
/// (S -> C) Sent during login to list available emergency trials (?).
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x11)]
#[Flags(Flags::PACKED)]
#[Magic(0xDE28, 0xDE)]
pub struct AvailableEmergenciesPacket {
    /// Emergency definitions.
    pub definitions: FixedVec<0x40, EmergencyDefinition>,
    /// Number of definitions in the above array.
    pub count: u32,
}

/// (0x15, 0x14) Unknown
///
/// (S -> C) 
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Clone, Default, PartialEq, PacketReadWrite)]
#[Id(0x15, 0x14)]
pub struct Unk1514Packet {
    pub zone_id: u32,
    pub unk2: u32,
}

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

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct Unk1502_1 {
    pub unk1: FixedBytes<0x24>,
}

/// Emergency trial pass/fail condition.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct EmergencyCondition {
    /// Condition string ID.
    pub cond_name: AsciiString,
    pub cond_data: Vec<Unk1502_1>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct Unk1502_3 {
    pub unk1: FixedBytes<0x4C>,
}

/// Emergency definition
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
#[derive(Debug, Default, Clone, PartialEq, HelperReadWrite)]
pub struct EmergencyDefinition {
    /// Condition string ID.
    pub trial_id: AsciiString,
    pub unk1: u16,
    pub unk2: u16,
}