echovr_api.player module

class echovr_api.player.Player(name='', playerid=None, userid=None, level=0, number=0, possession=False, stunned=False, blocking=False, invulnerable=False, position=None, velocity=None, lhand=None, rhand=None, forward=None, left=None, up=None, stats={})[source]

Bases: object

Represents the state of a single player in the current game

Initialized using data directly from the Echo VR API. See the Echo VR API documentation for further details on the attributes associated with this class, and the expected intialization parameters.

Parameters:
  • name (str) – The username of the player.
  • playerid (Optional[int]) – A number representing ID of the player within the current game session.
  • userid (Optional[int]) – A unique number identifying the player across all game sessions.
  • level (int) – A number (1-50) representing the player’s experience “level”.
  • number (int) – The number a player chose for themselves in the customization room.
  • possession (bool) – Indicates whether this player currently has posession of the disk.
  • stunned (bool) – Whether the player is currently stunned.
  • blocking (bool) – Whether the player is currently blocking.
  • invulnerable (bool) – Whether or not the player is currently immune to stuns.
  • position (Optional[List[float]]) – The current position of the player within the arena
  • velocity (Optional[List[float]]) – The current velocity (speed and direction of movement) of the player.
  • lhand (Optional[List[float]]) – The position of the player’s left hand within the Arena.
  • rhand (Optional[List[float]]) – The position of the player’s right hand within the Arena.
  • forward (Optional[List[float]]) – The direction that the player’s head is facing.
  • left (Optional[List[float]]) – The direction that the left side of the player’s head is facing.
  • up (Optional[List[float]]) – The direction that the top side of the player’s head is facing.
  • stats (dict) – A dict containing data used to instantiate the player’s current stats.
blocking = None

Whether the player is currently blocking.

forward = None

A Vector3D represnting the direction that the player’s head is facing.

invulnerable = None

Whether or not the player is currently immune to stuns.

left = None

A Vector3D represnting the direction that the left side of the player’s head is facing.

level = None

A integer (1-50) representing the player’s experience “level”.

lhand = None

A Vector3D represnting the position of the player’s left hand

name = None

The username of the player.

number = None

The number a player chose for themselves in the customization room.

playerid = None

A integer representing ID of the player within the current game session.

position = None

A Vector3D represnting the position of the player’s head

possession = None

Whether this player currently has posession of the disk.

rhand = None

A Vector3D represnting the position of the player’s right hand

stats = None

The Stats object for this player

stunned = None

Whether the player is currently stunned.

up = None

A Vector3D represnting the direction that the top of the player’s head is facing.

userid = None

A unique integer identifying the player across all game sessions.

username

The username of the player.

velocity = None

A Vector3D representing the current speed and direction of movement of the player.