godot/doc/classes/VisibilityEnabler2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.1">
	<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>
	</methods>
	<members>
		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [RigidBody2D] nodes will be paused.
		</member>
		<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [AnimatedSprite] nodes will be paused.
		</member>
		<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [AnimationPlayer] nodes will be paused.
		</member>
		<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [Particles2D] nodes will be paused.
		</member>
		<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] the parent's [method Node._physics_process] will be stopped.
		</member>
		<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] the parent's [method Node._process] will be stopped.
		</member>
	</members>
	<constants>
		<constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler">
			This enabler will pause [AnimationPlayer] nodes.
		</constant>
		<constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler">
			This enabler will freeze [RigidBody2D] nodes.
		</constant>
		<constant name="ENABLER_PAUSE_PARTICLES" value="2" enum="Enabler">
			This enabler will stop [Particles2D] nodes.
		</constant>
		<constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler">
			This enabler will stop the parent's _process function.
		</constant>
		<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler">
			This enabler will stop the parent's _physics_process function.
		</constant>
		<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">
		</constant>
		<constant name="ENABLER_MAX" value="6" enum="Enabler">
		</constant>
	</constants>
</class>