Struct google_api_proto::google::maps::playablelocations::v3::SamplePlayableLocationsRequest

pub struct SamplePlayableLocationsRequest {
    pub area_filter: Option<AreaFilter>,
    pub criteria: Vec<Criterion>,
}

Life of a query:

• When a game starts in a new location, your game server issues a [SamplePlayableLocations][google.maps.playablelocations.v3.PlayableLocations.SamplePlayableLocations] request. The request specifies the S2 cell, and contains one or more “criteria” for filtering:

• Criterion 0: i locations for long-lived bases, or level 0 monsters, or…

• Criterion 1: j locations for short-lived bases, or level 1 monsters, …

• Criterion 2: k locations for random objects.

• etc (up to 5 criterion may be specified).

PlayableLocationList will then contain mutually exclusive lists of PlayableLocation objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state.

Note: These points are impermanent in nature. E.g, parks can close, and places can be removed.

The response specifies how long you can expect the playable locations to last. Once they expire, you should query the samplePlayableLocations API again to get a fresh view of the real world.

Fields

area_filter: Option<AreaFilter>

Required. Specifies the area to search within for playable locations.

criteria: Vec<Criterion>

Required. Specifies one or more (up to 5) criteria for filtering the returned playable locations.

Trait Implementations

impl Clone for SamplePlayableLocationsRequest

fn clone(&self) -> SamplePlayableLocationsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamplePlayableLocationsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SamplePlayableLocationsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SamplePlayableLocationsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SamplePlayableLocationsRequest

fn eq(&self, other: &SamplePlayableLocationsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamplePlayableLocationsRequest