GKGameActivityDefinition

Inherits: RefCounted < Object

Describes a Game Activity template.

Description

Wraps GKGameActivityDefinition, including metadata, defaults, and associated leaderboard/achievement loaders.

Properties

Dictionary[String, String]	default_properties	{}
String	details	""
String	fallback_url	""
String	group_identifier	""
String	identifier	""
Variant	max_players
Variant	min_players
int	play_style	0
int	release_state	0
bool	supports_party_code	false
bool	supports_unlimited_players	false
String	title	""

Methods

void	load_achievement_descriptions(callback: Callable)
void	load_game_activity_definitions(callback: Callable) static
void	load_game_activity_definitions_with_ids(ids: PackedStringArray, callback: Callable) static
void	load_image(callback: Callable)
void	load_leaderboards(callback: Callable)

---

Property Descriptions

Dictionary[String, String] default_properties = {} 🔗

• Dictionary[String, String] get_default_properties()

Default key/value metadata assigned to created activities.

---

String details = "" 🔗

• String get_details()

Detailed description.

---

String fallback_url = "" 🔗

• String get_fallback_url()

Fallback URL when direct activity launch is unavailable.

---

String group_identifier = "" 🔗

• String get_group_identifier()

Group identifier for related activity definitions.

---

String identifier = "" 🔗

• String get_identifier()

Unique definition identifier.

---

Variant max_players 🔗

• Variant get_max_players()

Maximum supported player count, or null if unspecified.

---

Variant min_players 🔗

• Variant get_min_players()

Minimum supported player count, or null if unspecified.

---

int play_style = 0 🔗

• int get_play_style()

Apple play-style raw value.

---

int release_state = 0 🔗

• int get_release_state()

Apple release-state raw value.

---

bool supports_party_code = false 🔗

• bool get_supports_party_code()

Whether party-code joining is supported.

---

bool supports_unlimited_players = false 🔗

• bool get_supports_unlimited_players()

Whether unlimited player counts are supported.

---

String title = "" 🔗

• String get_title()

Display title.

---

Method Descriptions

void load_achievement_descriptions(callback: Callable) 🔗

Loads achievement descriptions associated with this definition.

---

void load_game_activity_definitions(callback: Callable) static 🔗

Loads available game activity definitions.

---

void load_game_activity_definitions_with_ids(ids: PackedStringArray, callback: Callable) static 🔗

Loads game activity definitions matching ids. Pass them as PackedStringArray(["activity_id_1", "activity_id_2"]).

---

void load_image(callback: Callable) 🔗

Loads this definition’s image.

---

void load_leaderboards(callback: Callable) 🔗

Loads leaderboards associated with this definition.