A Python module implemented in Rust for serializing and deserializing RLBot's flatbuffers
Project description
rlbot-flatbuffers-py
A Python module implemented in Rust for serializing and deserializing RLBot's flatbuffers
The goal of this project
To provide a fast, safe, and easy to use Python module for serializing and deserializing RLBot's flatbuffers.
A majority of the code is generated in the build.rs
upon first compile and thrown into src/python
.
This includes the code generated by flatc
(living in src/generated
), the Python wrapper binds to the generated Rust code, and the Python type hints (rlbot_flatbuffers.pyi
).
Basic usage
All classes and methods should have types hints readable by your IDE, removing the guesswork of common operations.
Creating
import rlbot_flatbuffers as flat
desired_ball = flat.DesiredBallState(
physics=flat.Physics(
location=flat.Vector3Partial(z=200),
velocity=flat.Vector3Partial(x=1500, y=1500),
angular_velocity=flat.Vector3Partial(),
),
)
desired_game_info = flat.DesiredGameInfoState(
world_gravity_z=-100,
game_speed=2,
)
desired_game_state = flat.DesiredGameState(
ball_state=desired_ball,
game_info_state=desired_game_info,
)
In the above code, we:
- Set the ball to:
- Location (0, 0, 200)
- Velocity (1500, 1500, 0)
- Angular velocity of (0, 0, 0)
- Don't set the car states
- Set the game info state:
- World gravity to -100
- Game speed to 2x default
- Don't set end match or paused
- Don't set any console commands
All values are optional when creating a class and have the proper defaults.
Reading values
import rlbot_flatbuffers as flat
def handle_packet(packet: flat.GameTickPacket):
if packet.game_info.game_state_type not in {
flat.GameStateType.Active,
flat.GameStateType.Kickoff,
}:
# Return early if the game isn't active
return
# Print the ball's location
print(packet.ball.physics.location)
for car in packet.players:
# Print the every car's location
print(car.physics.location)
The goal of the above was to feel familiar to RLBot v4 while providing a more Pythonic interface.
- All enum types are hashable and can be used in a set, allowing for easy checks against them.
- Every class implements
__str__
,__repr__
, and__hash__
methods.- All enums also implement
__int__
and__richcmp__
.
- All enums also implement
- Lists no longer have
num_x
fields accompanying them, they are just Python lists of the appropriate length.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for rlbot_flatbuffers-0.4.0-cp310-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c74cec3d5999fcdd45ef1ddf61eb3a4fabc5e7088d445c95379fb501564d787d |
|
MD5 | 3bb8bbf1d431943f1f5feef46f61c910 |
|
BLAKE2b-256 | 13bc6837db8f3e9a731e07f3de5fd55dafc84f429727d17d32c392e675cd3436 |
Hashes for rlbot_flatbuffers-0.4.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c671c55695eb5f92b53634196c027e317f6e2fed720d84fb5ed2b9cb5b7d6a1a |
|
MD5 | c85fa7c30f73b430cb3691cf818c41bb |
|
BLAKE2b-256 | 321f1dc00a67647ce3cb19498cc74788f422c70c62418b1a9932ebe88f9e3a4b |