Module valolyticspy.dtos.valorant_api.map

Expand source code
from pydantic import BaseModel
from typing import List, Optional

class Location(BaseModel):
    """
    Represents a location with x and y coordinates.
    
    Attributes:
        x (float): The x-coordinate of the location.
        y (float): The y-coordinate of the location.
    """
    x: float
    y: float

class Callout(BaseModel):
    """
    Represents a callout for a specific location on the map.
    
    Attributes:
        regionName (str): The name of the region where the callout is located.
        superRegionName (str): The name of the super region where the callout is located.
        location (Location): The specific location of the callout.
    """
    regionName: str
    superRegionName: str
    location: Location

class Map(BaseModel):
    """
    Represents a map in the Valorant game.

    Attributes:
        uuid (str): The unique identifier of the map.
        displayName (str): The display name of the map.
        narrativeDescription (str, optional): The narrative description of the map. Defaults to None.
        tacticalDescription (str, optional): The tactical description of the map. Defaults to None.
        coordinates (str, optional): The coordinates of the map. Defaults to None.
        displayIcon (str, optional): The display icon of the map. Defaults to None.
        listViewIcon (str): The list view icon of the map.
        listViewIconTall (str, optional): The tall list view icon of the map. Defaults to None.
        splash (str): The splash image of the map.
        stylizedBackgroundImage (str, optional): The stylized background image of the map. Defaults to None.
        premierBackgroundImage (str, optional): The premier background image of the map. Defaults to None.
        assetPath (str): The asset path of the map.
        mapUrl (str): The URL of the map.
        xMultiplier (float): The X multiplier of the map.
        yMultiplier (float): The Y multiplier of the map.
        xScalarToAdd (float): The X scalar to add to the map.
        yScalarToAdd (float): The Y scalar to add to the map.
        callouts (List[Callout], optional): The list of callouts for the map. Defaults to None.
    """
    uuid:str
    displayName:str
    narrativeDescription:Optional[str] = None
    tacticalDescription:Optional[str] = None
    coordinates:Optional[str] = None
    displayIcon:Optional[str] = None
    listViewIcon:str
    listViewIconTall:Optional[str] = None
    splash:str
    stylizedBackgroundImage:Optional[str] = None
    premierBackgroundImage:Optional[str] = None
    assetPath:str
    mapUrl:str
    xMultiplier:float
    yMultiplier:float
    xScalarToAdd:float
    yScalarToAdd:float
    callouts:Optional[List[Callout]] = None

Classes

class Callout (**data: Any)

Represents a callout for a specific location on the map.

Attributes

regionName : str
The name of the region where the callout is located.
superRegionName : str
The name of the super region where the callout is located.
location : Location
The specific location of the callout.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code
class Callout(BaseModel):
    """
    Represents a callout for a specific location on the map.
    
    Attributes:
        regionName (str): The name of the region where the callout is located.
        superRegionName (str): The name of the super region where the callout is located.
        location (Location): The specific location of the callout.
    """
    regionName: str
    superRegionName: str
    location: Location

Ancestors

  • pydantic.main.BaseModel

Class variables

var locationLocation
var model_computed_fields
var model_config
var model_fields
var regionName : str
var superRegionName : str
class Location (**data: Any)

Represents a location with x and y coordinates.

Attributes

x : float
The x-coordinate of the location.
y : float
The y-coordinate of the location.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code
class Location(BaseModel):
    """
    Represents a location with x and y coordinates.
    
    Attributes:
        x (float): The x-coordinate of the location.
        y (float): The y-coordinate of the location.
    """
    x: float
    y: float

Ancestors

  • pydantic.main.BaseModel

Class variables

var model_computed_fields
var model_config
var model_fields
var x : float
var y : float
class Map (**data: Any)

Represents a map in the Valorant game.

Attributes

uuid : str
The unique identifier of the map.
displayName : str
The display name of the map.
narrativeDescription : str, optional
The narrative description of the map. Defaults to None.
tacticalDescription : str, optional
The tactical description of the map. Defaults to None.
coordinates : str, optional
The coordinates of the map. Defaults to None.
displayIcon : str, optional
The display icon of the map. Defaults to None.
listViewIcon : str
The list view icon of the map.
listViewIconTall : str, optional
The tall list view icon of the map. Defaults to None.
splash : str
The splash image of the map.
stylizedBackgroundImage : str, optional
The stylized background image of the map. Defaults to None.
premierBackgroundImage : str, optional
The premier background image of the map. Defaults to None.
assetPath : str
The asset path of the map.
mapUrl : str
The URL of the map.
xMultiplier : float
The X multiplier of the map.
yMultiplier : float
The Y multiplier of the map.
xScalarToAdd : float
The X scalar to add to the map.
yScalarToAdd : float
The Y scalar to add to the map.
callouts : List[Callout], optional
The list of callouts for the map. Defaults to None.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code
class Map(BaseModel):
    """
    Represents a map in the Valorant game.

    Attributes:
        uuid (str): The unique identifier of the map.
        displayName (str): The display name of the map.
        narrativeDescription (str, optional): The narrative description of the map. Defaults to None.
        tacticalDescription (str, optional): The tactical description of the map. Defaults to None.
        coordinates (str, optional): The coordinates of the map. Defaults to None.
        displayIcon (str, optional): The display icon of the map. Defaults to None.
        listViewIcon (str): The list view icon of the map.
        listViewIconTall (str, optional): The tall list view icon of the map. Defaults to None.
        splash (str): The splash image of the map.
        stylizedBackgroundImage (str, optional): The stylized background image of the map. Defaults to None.
        premierBackgroundImage (str, optional): The premier background image of the map. Defaults to None.
        assetPath (str): The asset path of the map.
        mapUrl (str): The URL of the map.
        xMultiplier (float): The X multiplier of the map.
        yMultiplier (float): The Y multiplier of the map.
        xScalarToAdd (float): The X scalar to add to the map.
        yScalarToAdd (float): The Y scalar to add to the map.
        callouts (List[Callout], optional): The list of callouts for the map. Defaults to None.
    """
    uuid:str
    displayName:str
    narrativeDescription:Optional[str] = None
    tacticalDescription:Optional[str] = None
    coordinates:Optional[str] = None
    displayIcon:Optional[str] = None
    listViewIcon:str
    listViewIconTall:Optional[str] = None
    splash:str
    stylizedBackgroundImage:Optional[str] = None
    premierBackgroundImage:Optional[str] = None
    assetPath:str
    mapUrl:str
    xMultiplier:float
    yMultiplier:float
    xScalarToAdd:float
    yScalarToAdd:float
    callouts:Optional[List[Callout]] = None

Ancestors

  • pydantic.main.BaseModel

Class variables

var assetPath : str
var callouts : Optional[List[Callout]]
var coordinates : Optional[str]
var displayIcon : Optional[str]
var displayName : str
var listViewIcon : str
var listViewIconTall : Optional[str]
var mapUrl : str
var model_computed_fields
var model_config
var model_fields
var narrativeDescription : Optional[str]
var premierBackgroundImage : Optional[str]
var splash : str
var stylizedBackgroundImage : Optional[str]
var tacticalDescription : Optional[str]
var uuid : str
var xMultiplier : float
var xScalarToAdd : float
var yMultiplier : float
var yScalarToAdd : float