User:Jackoalan/PART (File Format) - Revision history

Jackoalan: Redirected page to PART (File Format)

2016-03-03T07:32:12Z

Redirected page to PART (File Format)

Show changes

Jackoalan: /* PART Properties */

2016-03-03T07:27:59Z

‎PART Properties

Jackoalan: /* PART Properties */

2016-03-03T04:26:43Z

‎PART Properties

Jackoalan: /* PART Properties */

2016-03-03T00:57:37Z

‎PART Properties

Jackoalan: Created page with "{{research|1|Key descriptions are subject to corrections}} The '''PART''' particle script format is used to configure ''particle effects''. Particles are..."

2016-03-02T22:48:43Z

Created page with "{{research|1|Key descriptions are subject to corrections}} The '''PART''' particle script format is used to configure ''particle effects''. Particles are..."

New page

{{research|1|Key descriptions are subject to corrections}}
The '''PART''' [[Particle Script|particle script]] format is used to configure ''particle effects''.

Particles are the most widely-used effect in ''Metroid Prime'', with approximately
3,500 unique scripts across the [[PAK_(Metroid_Prime)|PAK archives]].
Each script configures a complete ''particle system'' that may draw into the scene.

The particle system is configurable to generate many visual effects:

* Flames and smoke
* Floating embers
* Water splashes/drips
* Dust and dirt in windy conditions
* Volumetric light "shimmers"
* Energy/plasma discharges
* Many others

The concept behind the particle system is quite simple: lots of
view-aligned (camera-facing) quads with a texture-image
are emitted, positioned, rotated, sized, colored, etc... according to the
parameters in the particle script.

== Particle System ==

The ''particle system'' ties together all procedures necessary to host an ''emitter''
and specifies the rate at which new particles should be created. New particles have a predetermined
''lifetime'' (in frames) set by the system, and the emitter initializes the position and velocity of these particles.
The system continuously updates all currently-living particles that it's created. This includes updating
properties like ''position'', ''velocity'', ''color'', ''size'' and ''view-rotation''.

=== Child Systems ===

Particle systems may also host ''child systems'' which are timed and positioned within the parent's reference.
Not only does this include other PART systems, but [[SWHC (File Format)|SWHC]] and [[ELSC (File Format)|ELSC]]
systems may be parented as well.

A good example of this is the ''flamethrower's'' system, which composes flame
particles with a trailing SWHC and small cinders from a separate PART.

=== Line Mode ===

When the <code>LINE</code> property is activated, particles are rendered as ''lines'' rather than quads.

The usual 3D particle position is used as the ''trailing-point'' of the line, with the ''leading-point'' computed
via positional-differential, scaled by other parameters. Lines sample textures diagonally as a single-texel strip,
allowing for gradients to be applied via spherical or diagonal ramp-textures.

=== Model Mode ===

When the <code>PMDL</code> property is provided with a [[CMDL (File Format)|CMDL]], particles are rendered
using that ''model'', in addition to the quad. Alternatively, <code>PMUS</code> generates a quad transformed
as if it were a model (non view aligned).

Model-based particles have a whole separate suite of properties for controlling local-transformation and color.
Most of the properties involving positioning and transforms from the client systems are shared from the
normal quad-mode.

Many weapon effects, notably the "sphere" of the charge-beam, are accomplished using particle models.

== Particle Instance ==

For each frame, each particle does the following primary tasks:

* Determines if particle's lifetime has finished, removing it from the scene and releasing its resources for newly created particles to use
* Invokes all [[Particle Script#Mod_Vector_Elements|velocity/position sources]]; advancing position 1/60th of a second
* Evaluates local transforms
** Size
** View-aligned rotation
** View-aligned offset
* Evaluates particle color (shader-multiplied with texture-image)

== Emitter ==

''Main article: [[Particle Script#Emitter_Elements|Emitter Elements]]''

Each particle-system employs a single ''emitter'' context.
The system generates a specified number of particles each frame;
the emitter initializing the position and velocity-vector for each.

== PART Properties ==

Particle generator properties are assembled into a [[Particle Script|particle script]]
file tagged with <code>GPSM</code>. Any of the following properties are loaded into a
''description'' class for constructing an arbitrary number of ''particle generators''.

{| class="wikitable"
! FourCC
! Type
! Description
! Scope
! Notes
! MP1
! MP2
! MP3
! DKCR
! DKCTF
|-
{{ParticlePropertyRow|PSIV|VectorElement|System Initial Velocity|System Init|Defines the initial velocity vector which moves the entire system in local orientation (may be overridden by <code>PSVM</code>)|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|PSVM|ModVectorElement|System Velocity Mod|System Post Particles Update|Mod Vector which influences the position and velocity of the entire system in local space|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|PSOV|VectorElement|System Orientation Velocity|System Post Particles Update|Angular velocity (in degrees/frame) of the system's orientation|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|PSLT|IntElement|System Lifetime|System Init|Count of frames that the system generates new particles|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|PSWT|IntElement|System Warmup Time|System Warmup-Phase Update|Count of frames that the particle system virtually updates itself within one initial frame; exiting the warmup phase afterwards|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|PSTS|RealElement|System Time Scale|System Pre Particles Update|Factor that redefines the second for the system, including the rate at which the system's frame count is incremented. 1.0 is native 60-fps. 0.5 causes every other frame to skip updates, slowing down and making the motion "choppy". 2.0 causes 2 updates every frame, speeding up.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
{{ParticlePropertyRow|POFS|VectorElement|Particle Offset|System Init, System Post Particles Update|Vector that offsets all particles in world-space|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}

|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

@@ Line 128: / Line 128: @@
 {{ParticlePropertyRow|CIND|bool|Colored Indirect Texture|System Init|When <code>TIND</code> is active, texels copied from the underlying framebuffer are multiplied with the texels in <code>TEXR</code> (rather than added). The alpha component is ''always'' multiplied.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
 {{ParticlePropertyRow|OPTS|bool|Optional System|System Init|When a client system constructs a generator instance, it has the option to filter out child systems at any level that aren't essential to the effect. The exclusion is a mutual decision between the client and the particle description via this property.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
-{{ParticlePropertyRow|OPTS|bool|Optional System|System Init|When a client system constructs a generator instance, it has the option to filter out child systems at any level that aren't essential to the effect. The exclusion is a mutual decision between the client and the particle description via this property.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|MBSP|IntElement|Motion Blur Samples|Pre Particles Update|When <code>MBLR</code> is active, this is the number of times the position differential of each particle instance is subdivided for overdraw|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|SIZE|RealElement|Particle Size|Particle Creation, Particle Update|Proportional scale (length and width) of particle quads|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
 |}

@@ Line 112: / Line 112: @@
 {{ParticlePropertyRow|ILOC|VectorElement|Particle Emit Location|Particle Creation|Position to initialize particle in local space (replaced by <code>EMTR</code>)|{{maybe|Demo}}|{{nocheck}}|{{nocheck}}|{{nocheck}}|{{nocheck}}}}
 {{ParticlePropertyRow|IVEC|VectorElement|Particle Emit Velocity|Particle Creation|Velocity to initialize particle in local space (replaced by <code>EMTR</code>)|{{maybe|Demo}}|{{nocheck}}|{{nocheck}}|{{nocheck}}|{{nocheck}}}}
 |}

@@ Line 96: / Line 96: @@
 ! DKCTF
 |-
-{{ParticlePropertyRow|PSIV|VectorElement|System Initial Velocity|System Init|Defines the initial velocity vector which moves the entire system in local orientation (may be overridden by <code>PSVM</code>)|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|PSIV|VectorElement|System Initial Velocity|System Init|Defines the initial velocity vector which moves the entire system in local orientation (may be overridden by <code>PSVM</code>)|{{maybe|Demo}}|{{nocheck}}|{{nocheck}}|{{nocheck}}|{{nocheck}}}}
-{{ParticlePropertyRow|PSVM|ModVectorElement|System Velocity Mod|System Post Particles Update|Mod Vector which influences the position and velocity of the entire system in local space|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|PSVM|ModVectorElement|System Velocity Mod|Post Particles Update|Mod Vector which influences the position and velocity of the entire system in local space|{{maybe|Demo}}|{{nocheck}}|{{nocheck}}|{{nocheck}}|{{nocheck}}}}
-{{ParticlePropertyRow|PSOV|VectorElement|System Orientation Velocity|System Post Particles Update|Angular velocity (in degrees/frame) of the system's orientation|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|PSOV|VectorElement|System Orientation Velocity|Post Particles Update|Angular velocity (in degrees/frame) of the system's orientation|{{maybe|Demo}}|{{nocheck}}|{{nocheck}}|{{nocheck}}|{{nocheck}}}}
 {{ParticlePropertyRow|PSLT|IntElement|System Lifetime|System Init|Count of frames that the system generates new particles|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
-{{ParticlePropertyRow|PSWT|IntElement|System Warmup Time|System Warmup-Phase Update|Count of frames that the particle system virtually updates itself within one initial frame; exiting the warmup phase afterwards|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|PSWT|IntElement|System Warmup Time|Warmup-Phase Update|Count of frames that the particle system virtually updates itself within one initial frame; exiting the warmup phase afterwards|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
-{{ParticlePropertyRow|PSTS|RealElement|System Time Scale|System Pre Particles Update|Factor that redefines the second for the system, including the rate at which the system's frame count is incremented. 1.0 is native 60-fps. 0.5 causes every other frame to skip updates, slowing down and making the motion "choppy". 2.0 causes 2 updates every frame, speeding up.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|PSTS|RealElement|System Time Scale|Pre Particles Update|Factor that redefines the second for the system, including the rate at which the system's frame count is incremented. 1.0 is native 60-fps. 0.5 causes every other frame to skip updates, slowing down and making the motion "choppy". 2.0 causes 2 updates every frame, speeding up.|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
-{{ParticlePropertyRow|POFS|VectorElement|Particle Offset|System Init, System Post Particles Update|Vector that offsets all particles in world-space|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|POFS|VectorElement|Particle Offset|System Init, Post Particles Update|Vector that offsets all particles in world space|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
+{{ParticlePropertyRow|SEED|IntElement|Random Seed|System Init|Value used to initialize the [[wikipedia:Linear congruential generator|LCG]] seed state used within the system's update and render cycles (default 99)|{{check}}|{{check}}|{{check}}|{{check}}|{{check}}}}
 |}