Class: Google::Apis::GamesV1::PlayerAchievement

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/games_v1/classes.rb,
generated/google/apis/games_v1/representations.rb,
generated/google/apis/games_v1/representations.rb

Overview

This is a JSON template for an achievement object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PlayerAchievement

Returns a new instance of PlayerAchievement.



2150
2151
2152
 
# File 'generated/google/apis/games_v1/classes.rb', line 2150

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#achievement_state ⇒ String

The state of the achievement. Possible values are:

  • "HIDDEN" - Achievement is hidden.
  • "REVEALED" - Achievement is revealed.
  • "UNLOCKED" - Achievement is unlocked. Corresponds to the JSON property achievementState

Returns:

  • (String) 


2115
2116
2117
 
# File 'generated/google/apis/games_v1/classes.rb', line 2115

def achievement_state
  @achievement_state
end

#current_steps ⇒ Fixnum

The current steps for an incremental achievement. Corresponds to the JSON property currentSteps

Returns:

  • (Fixnum) 


2120
2121
2122
 
# File 'generated/google/apis/games_v1/classes.rb', line 2120

def current_steps
  @current_steps
end

#experience_points ⇒ Fixnum

Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished. Corresponds to the JSON property experiencePoints

Returns:

  • (Fixnum) 


2127
2128
2129
 
# File 'generated/google/apis/games_v1/classes.rb', line 2127

def experience_points
  @experience_points
end

#formatted_current_steps_string ⇒ String

The current steps for an incremental achievement as a string. Corresponds to the JSON property formattedCurrentStepsString

Returns:

  • (String) 


2132
2133
2134
 
# File 'generated/google/apis/games_v1/classes.rb', line 2132

def formatted_current_steps_string
  @formatted_current_steps_string
end

#id ⇒ String

The ID of the achievement. Corresponds to the JSON property id

Returns:

  • (String) 


2137
2138
2139
 
# File 'generated/google/apis/games_v1/classes.rb', line 2137

def id
  @id
end

#kind ⇒ String

Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement. Corresponds to the JSON property kind

Returns:

  • (String) 


2143
2144
2145
 
# File 'generated/google/apis/games_v1/classes.rb', line 2143

def kind
  @kind
end

#last_updated_timestamp ⇒ Fixnum

The timestamp of the last modification to this achievement's state. Corresponds to the JSON property lastUpdatedTimestamp

Returns:

  • (Fixnum) 


2148
2149
2150
 
# File 'generated/google/apis/games_v1/classes.rb', line 2148

def last_updated_timestamp
  @last_updated_timestamp
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2155
2156
2157
2158
2159
2160
2161
2162
2163
 
# File 'generated/google/apis/games_v1/classes.rb', line 2155

def update!(**args)
  @achievement_state = args[:achievement_state] if args.key?(:achievement_state)
  @current_steps = args[:current_steps] if args.key?(:current_steps)
  @experience_points = args[:experience_points] if args.key?(:experience_points)
  @formatted_current_steps_string = args[:formatted_current_steps_string] if args.key?(:formatted_current_steps_string)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp)
end