asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/VisibilityEnabler2D.xml

71 lines
2.7 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Remove revision.module_config from version string It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-11-15 18:37:54 +01:00
<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0-alpha">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Enable certain nodes only when visible.
</brief_description>
<description>
The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="is_enabler_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">
</argument>
<description>
Returns whether the specified enabler was set to true or not.
</description>
</method>
<method name="set_enabler">
<return type="void">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect.
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants>
<constant name="ENABLER_PAUSE_ANIMATIONS" value="0">
This enabler will pause [AnimationPlayer] nodes.
</constant>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02:00
<constant name="ENABLER_FREEZE_BODIES" value="1">
This enabler will freeze [RigidBody2D] nodes.
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constant name="ENABLER_PAUSE_PARTICLES" value="2">
This enabler will stop [Particles2D] nodes.
</constant>
<constant name="ENABLER_PARENT_PROCESS" value="3">
This enabler will stop the parent's _process function.
</constant>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4">
This enabler will stop the parent's _physics_process function.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02:00
<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5">
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constant name="ENABLER_MAX" value="6">
</constant>
</constants>
</class>
Reference in a new issue Copy permalink