mirror of
https://github.com/godotengine/godot.git
synced 2025-02-17 22:43:01 +08:00
Improve String.format() documentation
This commit is contained in:
parent
898e09e2e6
commit
25c7f567dd
@ -180,7 +180,22 @@
|
|||||||
<argument index="0" name="values" type="Variant" />
|
<argument index="0" name="values" type="Variant" />
|
||||||
<argument index="1" name="placeholder" type="String" default=""{_}"" />
|
<argument index="1" name="placeholder" type="String" default=""{_}"" />
|
||||||
<description>
|
<description>
|
||||||
Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code].
|
Formats the string by replacing all occurrences of [code]placeholder[/code] with the elements of [code]values[/code].
|
||||||
|
[code]values[/code] can be a [Dictionary] or an [Array]. Any underscores in [code]placeholder[/code] will be replaced with the corresponding keys in advance. Array elements use their index as keys.
|
||||||
|
[codeblock]
|
||||||
|
# Prints: Waiting for Godot is a play by Samuel Beckett, and Godot Engine is named after it.
|
||||||
|
var use_array_values = "Waiting for {0} is a play by {1}, and {0} Engine is named after it."
|
||||||
|
print(use_array_values.format(["Godot", "Samuel Beckett"]))
|
||||||
|
|
||||||
|
# Prints: User 42 is Godot.
|
||||||
|
print("User {id} is {name}.".format({"id": 42, "name": "Godot"}))
|
||||||
|
[/codeblock]
|
||||||
|
Some additional handling is performed when [code]values[/code] is an array. If [code]placeholder[/code] does not contain an underscore, the elements of the array will be used to replace one occurrence of the placeholder in turn; If an array element is another 2-element array, it'll be interpreted as a key-value pair.
|
||||||
|
[codeblock]
|
||||||
|
# Prints: User 42 is Godot.
|
||||||
|
print("User {} is {}.".format([42, "Godot"], "{}"))
|
||||||
|
print("User {id} is {name}.".format([["id", 42], ["name", "Godot"]]))
|
||||||
|
[/codeblock]
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_base_dir" qualifiers="const">
|
<method name="get_base_dir" qualifiers="const">
|
||||||
|
Loading…
Reference in New Issue
Block a user