OpenUT99-Plus
Unreal Engine 1, rebuilt from scratch
Loading...
Searching...
No Matches
upkg.h
Go to the documentation of this file.
1// Unreal packages and tagged properties. Specs: docs/formats/package.md, docs/formats/properties.md;
2// reference: tools/upkg.py, tools/uprops.py
3#pragma once
4#include <cstddef>
5#include <cstdint>
6#include <string>
7#include <vector>
8
9namespace ut {
10
11// Little-endian reader over a byte buffer. Throws std::runtime_error on any read past the end.
12struct Reader {
13 const std::vector<uint8_t>& data;
14 size_t pos = 0;
15 explicit Reader(const std::vector<uint8_t>& d, size_t p = 0) : data(d), pos(p) {}
16 uint8_t u8();
17 uint16_t u16();
18 uint32_t u32();
19 int32_t i32() { return int32_t(u32()); }
20 float f32();
21 int32_t index(); // compact index
22 std::string string(); // length-prefixed; negative length = UTF-16, returned as UTF-8
23 void need(size_t n) const;
24};
25
26struct Import {
28 int32_t package;
29 std::string name;
30};
31
32struct Export {
34 std::string name;
35 uint32_t flags;
36 int32_t size, offset;
37};
38
39struct Package {
40 int version = 0, licensee = 0;
41 uint32_t flags = 0;
42 std::vector<std::string> names;
43 std::vector<Import> imports;
44 std::vector<Export> exports;
45 std::vector<uint8_t> data;
46};
47
48Package parse_package(std::vector<uint8_t> data);
49Package load_package(const std::string& path);
50// 0 = "None", > 0 export ref - 1, < 0 import -ref - 1.
51std::string object_name(const Package& p, int32_t ref);
52// Lazy array: [u32 skip offset, version >= 62], compact item count, items. Returns the raw bytes.
53std::vector<uint8_t> lazy_bytes(Reader& r, int version, size_t item_size = 1);
54
55enum class PropType : uint8_t { Byte = 1, Int, Bool, Float, Object, Name, String, Class, Array, Struct, Vector, Rotator, Str, Map, FixedArray };
56
57struct Property {
58 std::string name;
60 int32_t index = 0; // array index
61 std::string struct_name; // Struct only
62 size_t value_pos = 0, size = 0;
63 bool bool_value = false;
64};
65
66struct Vec3 { float x, y, z; };
67
68// Tagged properties at the start of an export's data (after the state frame if any). *end = offset after "None".
69std::vector<Property> read_properties(const Package& p, const Export& e, size_t* end);
70int32_t prop_int(const Package& p, const Property& prop); // Int
71float prop_float(const Package& p, const Property& prop); // Float
72int32_t prop_ref(const Package& p, const Property& prop); // Object, Name (compact index)
73uint8_t prop_byte(const Package& p, const Property& prop); // Byte
74std::string prop_string(const Package& p, const Property& prop); // Str
75Vec3 prop_vector(const Package& p, const Property& prop); // Struct Vector, Scale (first 12 bytes)
76
77} // namespace ut
Definition collision.cpp:7
Package parse_package(std::vector< uint8_t > data)
Definition upkg.cpp:99
Vec3 prop_vector(const Package &p, const Property &prop)
Definition upkg.cpp:223
std::string prop_string(const Package &p, const Property &prop)
Definition upkg.cpp:221
std::vector< uint8_t > lazy_bytes(Reader &r, int version, size_t item_size)
Definition upkg.cpp:155
std::vector< Property > read_properties(const Package &p, const Export &e, size_t *end)
Definition upkg.cpp:169
std::string object_name(const Package &p, int32_t ref)
Definition upkg.cpp:145
int32_t prop_ref(const Package &p, const Property &prop)
Definition upkg.cpp:219
Package load_package(const std::string &path)
Definition upkg.cpp:139
float prop_float(const Package &p, const Property &prop)
Definition upkg.cpp:218
PropType
Definition upkg.h:55
@ Int
Definition upkg.h:55
@ Float
Definition upkg.h:55
@ String
Definition upkg.h:55
@ Array
Definition upkg.h:55
@ Map
Definition upkg.h:55
@ Name
Definition upkg.h:55
@ Vector
Definition upkg.h:55
@ Rotator
Definition upkg.h:55
@ Struct
Definition upkg.h:55
@ FixedArray
Definition upkg.h:55
@ Class
Definition upkg.h:55
@ Byte
Definition upkg.h:55
@ Bool
Definition upkg.h:55
@ Str
Definition upkg.h:55
uint8_t prop_byte(const Package &p, const Property &prop)
Definition upkg.cpp:220
int32_t prop_int(const Package &p, const Property &prop)
Definition upkg.cpp:217
Definition upkg.h:32
int32_t class_ref
Definition upkg.h:33
int32_t size
Definition upkg.h:36
int32_t offset
Definition upkg.h:36
int32_t package
Definition upkg.h:33
uint32_t flags
Definition upkg.h:35
int32_t super_ref
Definition upkg.h:33
std::string name
Definition upkg.h:34
Definition upkg.h:26
int32_t package
Definition upkg.h:28
std::string class_package
Definition upkg.h:27
std::string class_name
Definition upkg.h:27
std::string name
Definition upkg.h:29
Definition packages.h:11
Definition upkg.h:39
std::vector< Export > exports
Definition upkg.h:44
std::vector< std::string > names
Definition upkg.h:42
std::vector< uint8_t > data
Definition upkg.h:45
int licensee
Definition upkg.h:40
std::vector< Import > imports
Definition upkg.h:43
int version
Definition upkg.h:40
uint32_t flags
Definition upkg.h:41
Definition upkg.h:57
std::string name
Definition upkg.h:58
size_t size
Definition upkg.h:62
PropType type
Definition upkg.h:59
bool bool_value
Definition upkg.h:63
std::string struct_name
Definition upkg.h:61
size_t value_pos
Definition upkg.h:62
int32_t index
Definition upkg.h:60
Definition upkg.h:12
uint32_t u32()
Definition upkg.cpp:26
size_t pos
Definition upkg.h:14
const std::vector< uint8_t > & data
Definition upkg.h:13
float f32()
Definition upkg.cpp:34
std::string string()
Definition upkg.cpp:69
void need(size_t n) const
Definition upkg.cpp:10
int32_t i32()
Definition upkg.h:19
int32_t index()
Definition upkg.cpp:41
uint8_t u8()
Definition upkg.cpp:14
uint16_t u16()
Definition upkg.cpp:19
Reader(const std::vector< uint8_t > &d, size_t p=0)
Definition upkg.h:15
Definition upkg.h:66
float x
Definition upkg.h:66
float y
Definition upkg.h:66
float z
Definition upkg.h:66