Updated README

This commit is contained in:
Dominik Moritz Roth 2024-10-10 16:54:43 +02:00
parent 70fd128465
commit b750e80c80

View File

@ -53,10 +53,7 @@ print(f"Rods Position Ordered: {nucon.RODS_POS_ORDERED.value}")
## API Reference ## API Reference
The `nucon` instance contains all available parameters. Each parameter is defined with: The `nucon` instance contains all available parameters.
- An ID (string)
- A type (float, int, bool, str, or a custom Enum)
- A boolean indicating whether it's writable
Parameter properties: Parameter properties:
- `nucon.<PARAMETER>.value`: Get or set the current value of the parameter. Assigning a new value will write it to the game. - `nucon.<PARAMETER>.value`: Get or set the current value of the parameter. Assigning a new value will write it to the game.