virtualx-engine/doc/classes/Translation.xml
Hugo Locurcio b087538119
Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00

63 lines
2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Translation" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Language Translation.
</brief_description>
<description>
Translations are resources that can be loaded and unloaded on demand. They map a string to another string.
</description>
<tutorials>
<link>$DOCS_URL/tutorials/i18n/internationalizing_games.html</link>
<link>$DOCS_URL/tutorials/i18n/locales.html</link>
</tutorials>
<methods>
<method name="_get_message" qualifiers="virtual">
<return type="String" />
<argument index="0" name="src_message" type="String" />
<description>
Virtual method to override [method get_message].
</description>
</method>
<method name="add_message">
<return type="void" />
<argument index="0" name="src_message" type="String" />
<argument index="1" name="xlated_message" type="String" />
<description>
Adds a message if nonexistent, followed by its translation.
</description>
</method>
<method name="erase_message">
<return type="void" />
<argument index="0" name="src_message" type="String" />
<description>
Erases a message.
</description>
</method>
<method name="get_message" qualifiers="const">
<return type="String" />
<argument index="0" name="src_message" type="String" />
<description>
Returns a message's translation.
</description>
</method>
<method name="get_message_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of existing messages.
</description>
</method>
<method name="get_message_list" qualifiers="const">
<return type="PoolStringArray" />
<description>
Returns all the messages (keys).
</description>
</method>
</methods>
<members>
<member name="locale" type="String" setter="set_locale" getter="get_locale" default="&quot;en&quot;">
The locale of the translation.
</member>
</members>
<constants>
</constants>
</class>