virtualx-engine/doc/classes/GPUParticlesCollisionSphere3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GPUParticlesCollisionSphere3D" inherits="GPUParticlesCollision3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Sphere-shaped 3D particle collision shape affecting [GPUParticles3D] nodes.
	</brief_description>
	<description>
		Sphere-shaped 3D particle collision shape affecting [GPUParticles3D] nodes.
		[b]Note:[/b] [member ParticlesMaterial.collision_mode] must be [constant ParticlesMaterial.COLLISION_RIGID] or [constant ParticlesMaterial.COLLISION_HIDE_ON_CONTACT] on the [GPUParticles3D]'s process material for collision to work.
		[b]Note:[/b] Particle collision only affects [GPUParticles3D], not [CPUParticles3D].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
			The collision sphere's radius in 3D units.
		</member>
	</members>
</class>
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
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-02-14 14:18:53 +01:00			`<class name="GPUParticlesCollisionSphere3D" inherits="GPUParticlesCollision3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`<brief_description>`
Document GPUParticles3D attractors and collision 2022-05-13 04:11:01 +02:00			`Sphere-shaped 3D particle collision shape affecting [GPUParticles3D] nodes.`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</brief_description>`
			`<description>`
Document GPUParticles3D attractors and collision 2022-05-13 04:11:01 +02:00			`Sphere-shaped 3D particle collision shape affecting [GPUParticles3D] nodes.`
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either. 2022-05-20 23:59:13 +02:00			`[b]Note:[/b] [member ParticlesMaterial.collision_mode] must be [constant ParticlesMaterial.COLLISION_RIGID] or [constant ParticlesMaterial.COLLISION_HIDE_ON_CONTACT] on the [GPUParticles3D]'s process material for collision to work.`
Document GPUParticles3D attractors and collision 2022-05-13 04:11:01 +02:00			`[b]Note:[/b] Particle collision only affects [GPUParticles3D], not [CPUParticles3D].`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
			`<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">`
Document GPUParticles3D attractors and collision 2022-05-13 04:11:01 +02:00			`The collision sphere's radius in 3D units.`
doc: Sync classref with current source 2020-10-12 10:57:54 +02:00			`</member>`
			`</members>`
			`</class>`