diff options
Diffstat (limited to 'doc/classes/VisibilityEnabler.xml')
| -rw-r--r-- | doc/classes/VisibilityEnabler.xml | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 910ca033d1..e3c7d05fce 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.2"> <brief_description> - Enable certain nodes only when visible. + Enables certain nodes only when visible. </brief_description> <description> The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. @@ -9,12 +9,30 @@ <tutorials> </tutorials> <methods> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> + </argument> + <description> + </description> + </method> + <method name="set_enabler"> + <return type="void"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> </methods> <members> - <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true"> If [code]true[/code], [RigidBody] nodes will be paused. </member> - <member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + <member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true"> If [code]true[/code], [AnimationPlayer] nodes will be paused. </member> </members> @@ -26,6 +44,7 @@ This enabler will freeze [RigidBody] nodes. </constant> <constant name="ENABLER_MAX" value="2" enum="Enabler"> + Represents the size of the [enum Enabler] enum. </constant> </constants> </class> |