Models

Models used for communication with the REST API.

class pymirokai.models.data_models.BoolCommand(**data)

Bases: BaseModel

Represents a command associated with a Boolean value.

This model is crucial for enabling or disabling features through API commands, such as toggling settings.

Parameters:

  • command (str)

  • value (bool)

command: str

The command to be executed.

value: bool

The Boolean state (True or False) that the command will apply.

class pymirokai.models.data_models.Coordinates(**data)

Bases: BaseModel

Defines a set of coordinates in a three-dimensional space along with an orientation.

This model is used to represent spatial data with an optional rotational component, which is crucial for navigation and positioning tasks in a 3D environment.

Parameters:

  • x (float)

  • y (float)

  • z (float)

  • theta (float)

theta: float

The rotation around the Z-axis, in degrees. Default is 0.0.

to_list()

Convert coordinates model to a [x, y, z] list.

Return type:

list

x: float

The X-coordinate in space, representing horizontal movement (forward/backward). Default is 0.0.

y: float

The Y-coordinate in space, representing horizontal movement (left/right). Default is 0.0.

z: float

The Z-coordinate in space, representing vertical movement (up/down). Default is 0.0.

class pymirokai.models.data_models.DepositZone(**data)

Bases: Rune

Represents a deposit zone.

Parameters:

id (str)

class pymirokai.models.data_models.DictCommand(**data)

Bases: BaseModel

Models a command that involves dictionary data.

Often used for commands requiring key-value pair configurations, particularly when adjusting complex settings.

Parameters:

  • command (str)

  • value (dict)

command: str

The command to be executed.

value: dict

The dictionary containing configuration data or parameters for the command.

class pymirokai.models.data_models.EnchantedLocation(**data)

Bases: Rune

Represents a rune representing a location.

Parameters:

id (str)

class pymirokai.models.data_models.EnchantedObject(**data)

Bases: Rune

Represents a rune representing an object to grasp.

Parameters:

id (str)

class pymirokai.models.data_models.EnchantedUser(**data)

Bases: Rune

Represents a rune representing a human.

Parameters:

id (str)

class pymirokai.models.data_models.FloatCommand(**data)

Bases: BaseModel

Defines a command that includes a floating-point number.

Used for commands that involve precision settings or adjustments, such as configuring sensitivity levels.

Parameters:

  • command (str)

  • value (float)

command: str

The command to be executed.

value: float

The floating-point number that specifies the command’s parameter.

class pymirokai.models.data_models.IntCommand(**data)

Bases: BaseModel

Encapsulates a command that requires an integer value.

This model is used for commands that adjust settings or configure parameters represented as integers.

Parameters:

  • command (str)

  • value (int)

command: str

The command to be executed.

value: int

The integer value necessary to carry out the command.

class pymirokai.models.data_models.ListCommand(**data)

Bases: BaseModel

Describes a command that involves a list of values.

This model is used for commands that need to handle multiple elements, such as configuring a series of actions or settings.

Parameters:

  • command (str)

  • value (list)

command: str

The command name.

value: list

The list of values to be processed or configured by the command.

class pymirokai.models.data_models.Location(**data)

Bases: BaseModel

Represents a location.

Parameters:

id (str)

id: str

The location id.

class pymirokai.models.data_models.NoArgCommand(**data)

Bases: BaseModel

Represents a command with no arguments.

This model is used for commands that do not require any parameters.

Parameters:

command (str)

command: str

The command name.

class pymirokai.models.data_models.Rune(**data)

Bases: BaseModel

Represents a rune.

Parameters:

id (str)

id: str

The run virtual id.

class pymirokai.models.data_models.StrCommand(**data)

Bases: BaseModel

Represents a command that involves a string value.

This model is used to process textual commands that modify settings or trigger actions within a system.

Parameters:

  • command (str)

  • value (str)

command: str

The command to be executed.

value: str

The string value associated with the command.