La méthode _to_string

Afficher un objet dont la classe ne définit pas _to_string() ne montre que sa classe et un identifiant interne, qui change d’une exécution à l’autre : <RefCounted#-9223372009541466673>. Définissez _to_string() et renvoyez le texte qui doit apparaître à la place :

# card.gd
class_name Card
extends RefCounted

var rank: String
var suit: String

func _init(new_rank: String, new_suit: String) -> void:
	rank = new_rank
	suit = new_suit

func _to_string() -> String:
	return rank + " of " + suit

Godot l’appelle chaque fois que l’objet est converti en texte : avec print(), avec str(), avec %s dans une chaîne de formatage, et pour chaque objet d’un Array ou d’un Dictionary affiché :

var card := Card.new("Queen", "hearts")
print(card) # Dame de cœur
print(str(card)) # Dame de cœur
print("You drew %s" % card) # Vous avez tiré la dame de cœur
print([card, Card.new("7", "clubs")]) # [Dame de cœur, 7 de trèfle]

"You drew " + card est toujours une erreur, car + concatène deux chaînes et card est un objet. Convertis-le d’abord : "You drew " + str(card).

Une sous-classe peut redéfinir _to_string() et utiliser le texte de la classe parente avec super() :

# wild_card.gd
class_name WildCard
extends Card

func _to_string() -> String:
	return "Wild " + super()

print(WildCard.new("King", "spades")) affiche Wild King of spades.

_to_string() renvoie le texte et n’affiche rien lui-même. Le code qui utilise l’objet décide si le texte est affiché, intégré à une ligne plus longue ou stocké.