virtualx-engine/doc/classes/StreamTexture.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

28 lines
962 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamTexture" inherits="Texture" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A [code].stex[/code] texture.
</brief_description>
<description>
A texture that is loaded from a [code].stex[/code] file.
</description>
<tutorials>
</tutorials>
<methods>
<method name="load">
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<description>
Loads the texture from the given path.
</description>
</method>
</methods>
<members>
<member name="flags" type="int" setter="set_flags" getter="get_flags" overrides="Texture" default="0" />
<member name="load_path" type="String" setter="load" getter="get_load_path" default="&quot;&quot;">
The StreamTexture's file path to a [code].stex[/code] file.
</member>
</members>
<constants>
</constants>
</class>