flatbuffers_python_monster_serialize_and_read_tutorial.py

1import flatbuffers
2
3# Import the generated classes (assuming monster_test_generated.py was created from monster.fbs)
4import MyGame.Example.Monster as Monster
5import MyGame.Example.Vec3 as Vec3
6import MyGame.Example.Color as Color
7import MyGame.Example.Weapon as Weapon
8import MyGame.Example.Equipment as Equipment
9
10# 1. BUILD THE FLATBUFFER
11builder = flatbuffers.Builder(1024)
12
13# Create some strings
14name = builder.CreateString("Orc")
15
16# Create a list/vector of weapons
17Weapon.Start(builder)
18Weapon.AddName(builder, builder.CreateString("Sword"))
19Weapon.AddDamage(builder, 3)
20sword = Weapon.End(builder)
21
22Weapon.Start(builder)
23Weapon.AddName(builder, builder.CreateString("Axe"))
24Weapon.AddDamage(builder, 5)
25axe = Weapon.End(builder)
26
27Monster.StartWeaponsVector(builder, 2)
28builder.PrependUOffsetTRelative(axe)
29builder.PrependUOffsetTRelative(sword)
30weapons = builder.EndVector()
31
32# Start building the monster
33Monster.Start(builder)
34Monster.AddPos(builder, Vec3.CreateVec3(builder, 1.0, 2.0, 3.0))
35Monster.AddHp(builder, 300)
36Monster.AddName(builder, name)
37Monster.AddColor(builder, Color.Color.Red)
38Monster.AddWeapons(builder, weapons)
39Monster.AddEquippedType(builder, Equipment.Equipment.Weapon)
40Monster.AddEquipped(builder, axe)
41orc = Monster.End(builder)
42
43builder.Finish(orc)
44
45# 2. READ THE FLATBUFFER
46buf = builder.Output()
47
48# Get access to the root
49monster = Monster.Monster.GetRootAs(buf, 0)
50
51# Access fields
52print(f"Monster Name: {monster.Name().decode('utf-8')}")
53print(f"HP: {monster.Hp()}")
54print(f"Color: {monster.Color()}")
55
56# Access a struct
57pos = monster.Pos()
58if pos:
59    print(f"Position: x={pos.X()} y={pos.Y()} z={pos.Z()}")
60
61# Access a vector
62weapons_len = monster.WeaponsLength()
63for i in range(weapons_len):
64    weapon = monster.Weapons(i)
65    print(f"Weapon {i}: {weapon.Name().decode('utf-8')} (Damage: {weapon.Damage()})")