@event

Mark a method as the handler for a named command.

Signature

@event(*, name: str, description: str = "")

The method’s parameters are the data the client sends, validated against their annotations and any InputField() constraints before the handler runs. Handlers can be async def or plain def, and run between steps, never during one.

@event(name="reset", description="Restart from the seed frame.")
def reset(self) -> WaypointStatus:
    self.engine.reset()
    return WaypointStatus.of(self.state, -1)

Returning a ModelMessage sends it back as that command’s correlated reply. The return annotation has to be one message class or None; a union is rejected when the class is declared. See Events & Messages. A handler whose name matches a generated set_<field> command replaces it.

Get Started

CLI & Platform

Build a Model

Media & Transport

Releases