virtualx-engine/doc/classes/StreamTexture.xml
Rémi Verschelde 542489a866 DocData: Re-expose parametric setters and getters
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.

For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00

28 lines
753 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamTexture" inherits="Texture" category="Core" version="3.2">
<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">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<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>