setLocalizableMessageWithKey(_:arguments:)
Sends a localized message from the current participant to all other participants when you end a turn, forfeit a match, or end a match.
Declaration
func setLocalizableMessageWithKey(_ key: String, arguments: [String]?)Parameters
- key:
The identifier for looking up the translated string in the default
Localized.stringsfile. If you use a formatted string with specifiers, provide the arguments. - arguments:
A list of arguments to substitute into the localized string if it’s formatted and contains specifiers.
Mentioned in
Discussion
Invoke this method only when the local player is the current participant and before you invoke a method that generates a turn-based event.
If your game isn’t running or is running in the background on other participant devices, a notification containing the localized message appears immediately at the top of the screen. If the game is in the foreground, use the message property to get the localized message when handling the turn-based event.
GameKit uses the recipient’s language and region to localize the message. If the recipient doesn’t have the game installed on their device, GameKit uses the sender’s localization settings instead. See Sending messages to players in turn-based games.