arena-py API v1.0.1
arena
Landmark attribute class to manage its properties in the ARENA: Define entities as a landmark; Landmarks appears in the landmark list and you can move (teleport) to them; You can define the behavior of the teleport: if you will be at a fixed or random distance, looking at the landmark, fixed offset or if it is constrained by a navmesh (when it exists).
Usage: landmark=Landmark(...)
Parameters
- str constrainToNavMesh: Teleports should snap to navmesh. Allows [false, any, coplanar] Defaults to 'false' (optional)
- str label: Landmark description to display in the landmark list. Defaults to '' (optional)
- bool lookAtLandmark: Set to true to make users face the landmark when teleported to it. Defaults to 'True' (optional)
- dict offsetPosition: Use as a static teleport x,y,z offset. Defaults to '{'x': 0, 'y': 1.6, 'z': 0}' (optional)
- float randomRadiusMax: Maximum radius from the landmark to teleport to. Defaults to '0' (optional)
- float randomRadiusMin: Minimum radius from the landmark to teleport to. (randomRadiusMax must > 0). Defaults to '0' (optional)
- bool startingPosition: Set to true to use this landmark as a scene start (spawn) position. If several landmarks with startingPosition=true exist in a scene, one will be randomly selected. Defaults to 'False' (optional)