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

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

Overview

An achievement object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PlayerAchievement

Returns a new instance of PlayerAchievement.



1823
1824
1825
 
# File 'lib/google/apis/games_v1/classes.rb', line 1823

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

Instance Attribute Details

#achievement_state ⇒ String

The state of the achievement. Corresponds to the JSON property achievementState

Returns:

  • (String) 


1788
1789
1790
 
# File 'lib/google/apis/games_v1/classes.rb', line 1788

def achievement_state
  @achievement_state
end

#current_steps ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1793
1794
1795
 
# File 'lib/google/apis/games_v1/classes.rb', line 1793

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) 


1800
1801
1802
 
# File 'lib/google/apis/games_v1/classes.rb', line 1800

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) 


1805
1806
1807
 
# File 'lib/google/apis/games_v1/classes.rb', line 1805

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) 


1810
1811
1812
 
# File 'lib/google/apis/games_v1/classes.rb', line 1810

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) 


1816
1817
1818
 
# File 'lib/google/apis/games_v1/classes.rb', line 1816

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) 


1821
1822
1823
 
# File 'lib/google/apis/games_v1/classes.rb', line 1821

def last_updated_timestamp
  @last_updated_timestamp
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/google/apis/games_v1/classes.rb', line 1828

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