GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest (google_api_playable_locations v0.3.0) View Source

Life of a query: - When a game starts in a new location, your game server issues a 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.

Attributes

  • areaFilter (type: GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SampleAreaFilter.t, default: nil) - Required. Specifies the area to search within for playable locations.
  • criteria (type: list(GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SampleCriterion.t), default: nil) - Required. Specifies one or more (up to 5) criteria for filtering the returned playable locations.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest{
    areaFilter:
      GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SampleAreaFilter.t()
      | nil,
    criteria:
      [
        GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SampleCriterion.t()
      ]
      | nil
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.