Bin & Particle Dictionary

Toutes les autres pages de cette section t'apprennent à faire quelque chose. Celle-ci est pour le moment où tu fais défiler un dump .py, tu tombes sur une propriété que tu n'as jamais vue, et tu veux juste savoir ce que c'est et où elle se trouve.

Les entrées sont regroupées par classe propriétaire, parce que dans un bin le même nom peut apparaître sur plusieurs classes, et savoir dans laquelle tu te trouves détermine ce que la valeur fait.

Comment lire un bin

Un bin VFX est un arbre. La colonne vertébrale ressemble à ça :

VfxSystemDefinitionData              un effet complet, par ex. un recall ou un Q
└── complexEmitterDefinitionData     la liste des émetteurs du système
    └── VfxEmitterDefinitionData     un émetteur : une traînée, un flash, des étincelles
        ├── primitive                ce que chaque particule dessine
        └── pointeurs *Definition    érosion, palette, distorsion, enfants, ...

VfxSystemDefinitionData est le conteneur. Une propriété qui n'est pas dans le système joué pendant une compétence n'apparaîtra pas pendant cette compétence.

L'émetteur est là où tu passes le plus de temps. Il porte 135 champs enregistrés à lui seul, et accroche une douzaine d'objets de sous-définition optionnels via des pointeurs. Un pointeur nul signifie que toute la fonctionnalité est désactivée, ce qui explique pourquoi supprimer un bloc est souvent la bonne façon de désactiver quelque chose.

Enveloppes de valeur

Les propriétés numériques sont généralement enveloppées pour que le moteur puisse les garder constantes ou les faire varier :

rate: embed = ValueFloat {
    constantValue: f32 = 20
}

Les enveloppes sont ValueFloat, ValueColor, ValueVector2 et ValueVector3. Chacune contient un constantValue plus un pointeur dynamics optionnel. Ce sont deux champs distincts, pas deux orthographes du même champ : la constante est toujours là, et dynamics est un objet supplémentaire accroché dessus.

Propriétés de naissance et leurs partenaires sur la durée de vie

Beaucoup de propriétés vont par paires. Celle en birth* est évaluée une fois, quand la particule apparaît. Sa partenaire sans le préfixe continue d'agir pendant toute la vie de la particule, et elle est multipliée avec la valeur de naissance plutôt que de la remplacer.

Si une valeur semble fausse et qu'une seule moitié d'une paire est renseignée, vérifie l'autre moitié avant de changer quoi que ce soit.

Unités

Les rotations et vitesses de rotation sont en degrés et en degrés par seconde. Les durées de vie, périodes et délais sont en secondes. Les vitesses de défilement UV sont en UV par seconde, et la rotation UV en degrés. Les canaux de couleur vont de 0 à 1.

Randomisation, et le suffixe 0

Plusieurs propriétés de naissance finissent par 0, comme birthScale0 et birthRotation0. C'est un reliquat de nommage, pas une paire minimum-maximum. Il n'existe pas de birthScale1 sur la classe d'émetteur actuelle. La variation par particule vient de probabilityTables, comme ci-dessus.

Octets de drapeaux

Beaucoup de booléens ne sont pas des champs séparés. Ce sont des bits isolés empaquetés dans des octets de drapeaux partagés sur l'émetteur. Les outils texte les exposent individuellement en flag, donc tu les écris un par un, mais ils vivent à quatre ou huit par octet. La liste complète est dans Drapeaux de l'émetteur.

Niveau système

VfxSystemDefinitionData, le conteneur le plus externe. 33 champs enregistrés au patch 16.16.

Émetteur : identité et durée de vie

VfxEmitterDefinitionData. Tout, d'ici jusqu'à Drapeaux de l'émetteur, est sur cette classe sauf mention contraire dans une ligne.

Comment importance fait le culling

importance est comparée au réglage Qualité des effets du joueur quand le système construit ses émetteurs. C'est une catégorie, pas une échelle, et deux des valeurs se comportent autrement que le nom ne le suggère.

Donc 0 à 3 montent en priorité, et 3 est critique pour le gameplay et n'est jamais retiré. 4 est un substitut basse qualité montré uniquement en réglages bas, et 5 est l'inverse, montré uniquement à partir de Moyenne. Associer un émetteur 4 à un émetteur 5 est la façon dont un effet livre deux versions de lui-même.

Quatre autres choses conditionnent l'existence même d'un émetteur : disabled, colorblindVisibility, ChanceToNotExist, et le bit 0x800 des flags système, qui retire tout sauf les importances 3 et 4.

rate, lifetime, particleLifetime et particleLinger sont illustrés avec des captures sur la page Emitter Library.

Émetteur : émission et rythme

Émetteur : placement et orientation

Émetteur : propriétés de naissance

L'état donné à une particule à l'instant de son apparition. Tout ce qui s'appelle birth* est une condition initiale, pas une condition continue.

Chacune a une jumelle flex* (flexBirthVelocity, flexBirthUVOffset, flexScaleBirthScale et ainsi de suite) qui la surcharge quand une valeur flex est fournie.

Émetteur : mouvement sur la durée de vie

Là où birth* fixe l'état de départ, celles-ci continuent d'agir.

Émetteur : couleur

Lire une valeur RGBA

birthColor: embed = ValueColor {
    constantValue: vec4 = { 1, 0.7059, 0, 1 }
}

Les canaux vont de 0 à 1 plutôt que de 0 à 255. Pour convertir, divise par 255. Le canal vert ci-dessus vaut 180, et 180 / 255 donne 0.7059.

La quatrième valeur est l'alpha, où 0 est totalement transparent et 1 totalement opaque.

Pour recolorier en pratique, Quartz fait les calculs pour toi.

Émetteur : texture et UV

Émetteur : état de rendu

Valeurs de blendMode

Elles sont fixes, et identiques pour toutes les primitives. Chaque mode choisit un facteur de mélange source et destination, et une opération de mélange.

Lire ce tableau en pratique :

• 0 et 4 sont les modes additifs. Le noir n'apporte rien, ce sont donc ceux qu'on peut recolorier vers le noir sans risque.
• 1 est le mélange alpha standard, ce qui se rapproche le plus de « normal ».
• 2 assombrit, puisqu'il multiplie par l'inverse de la couleur source.
• 3 est le mode opaque. C'est le seul qui écrit la profondeur et le seul qui ne mélange pas du tout.
• 6 et 7 prennent le minimum ou le maximum entre source et destination au lieu d'additionner.

Drapeaux de l'émetteur

Quatre octets sur l'émetteur, chacun portant jusqu'à huit bits nommés. Les outils texte les exposent un par un en flag.

Primitives

primitive est un pointeur qui décide de ce que chaque particule dessine. Le laisser vide donne le quad billboard face caméra par défaut.

Champs de mesh

Les primitives mesh portent un VfxMeshDefinitionData dans mMesh. Attention aux préfixes m : ils ne s'écrivent pas comme les champs propres à l'émetteur.

Les primitives mesh portent aussi AlignPitchToCamera et AlignYawToCamera sur VfxPrimitiveMeshBase.

Types de fichiers mesh

Une paire .skn et .skl dans un dossier de particules signifie un mesh animé. Voir Meshes as Particles.

Traînée et ruban

VfxPrimitiveTrailBase porte un VfxTrailDefinitionData dans mTrail :

VfxRibbonDefinitionData porte birthTilingSize en ValueVector2.

Classes de sous-définition

Chacune est accrochée à un pointeur sur l'émetteur. Nul signifie que la fonctionnalité est entièrement désactivée.

Texture mult

VfxTextureMultDefinitionData. Une seconde texture multipliée par-dessus la base, la même idée que Multiply dans un éditeur d'images. Le champ textureMult de l'émetteur pointe vers cet objet, et le nom de fichier réel est la chaîne textureMult à l'intérieur.

Son octet de drapeaux porte uvScrollAlphaMult, uvScrollClampMult, TextureMultFilpU, TextureMultFilpV et isRandomStartFrameMult. Ces deux-là s'écrivent vraiment comme ça dans le moteur, donc cherche « Filp » plutôt que « Flip » quand tu pars les chercher.

Palette

VfxPaletteDefinitionData. Colore les particules en échantillonnant une texture de dégradé au lieu d'utiliser une valeur plate.

Érosion alpha

VfxAlphaErosionDefinitionData. Dissout la particule avec une map. C'est ainsi que presque tout effet de combustion ou de balayage est construit.

Une map d'érosion est généralement en niveaux de gris, où le blanc s'érode en premier et le noir en dernier. Les maps multi-canaux portent un motif indépendant par canal de couleur, et erosionMapChannelMixer choisit entre eux.

Distorsion

VfxDistortionDefinitionData. Déforme ce qui est dessiné derrière la particule. Ondes de choc et effets de chaleur.

Réflexion et fresnel

VfxReflectionDefinitionData. Le bloc de réflexion et de liseré lumineux. fresnel vit ici, pas sur l'émetteur.

Soft particles

VfxSoftParticleDefinitionData. Adoucit la couture nette là où une particule croise la géométrie.

Il y a un cinquième octet de mode qui choisit lequel des deux fondus s'applique. Un pointeur softParticleParams nul désactive complètement la fonctionnalité, et il n'existe pas de champ on/off séparé.

Linger

VfxLingerDefinitionData. Modifie la particule pendant la phase de persistance au lieu de simplement retarder sa disparition.

Chacune a un drapeau Use* correspondant : UseLingerRotation, UseLingerScale, UseKeyedLingerVelocity, UseKeyedLingerAcceleration, UseKeyedLingerDrag et UseSeparateLingerColor. Renseigner la valeur sans son drapeau ne fait rien.

Matériaux et drivers

VfxMaterialDefinitionData contient un lien Material et une map materialDrivers. Les drivers animent un paramètre de matériau au lieu de le garder constant.

Pour le travail sur les glows et le toon shader, voir Static Materials.

Champs de forces

VfxFieldCollectionDefinitionData, atteint via le fieldCollectionDefinition de l'émetteur. Là où birthVelocity met une particule en mouvement, un champ continue d'agir sur elle.

Formes d'émission

SpawnShape pointe vers un IVfxShape.

VfxEmissionMeshData gère l'apparition depuis un mesh, avec meshName, skeletonName, AnimationName, meshScale, maxJointWeights, Submeshes et useSurfaceNormalForBirthPhysics.

Particules enfants

VfxChildParticleSetDefinitionData, atteint via le childParticleSetDefinition de l'émetteur. C'est ainsi qu'une traînée sème des étincelles ou qu'une explosion projette des débris.

VfxChildIdentifier contient effect (un lien), effectKey (un hash) et effectName (une chaîne).

VfxParentInheritanceParams contient Mode et RelativeOffset. Ce décalage est un canal relatif au parent à part entière, distinct de l'EmitterPosition propre à l'enfant.

Un motif courant est un émetteur parent en VfxPrimitiveNonRenderable : il ne dessine rien et n'existe que pour placer ses enfants.

Le modèle à composants legacy

Les effets plus anciens utilisent un second modèle d'émetteur à base de composants, toujours livré dans le moteur. Tu le croiseras sur les champions de longue date. Il est documenté ici pour que tu le reconnaisses, pas pour que tu écrives du nouveau travail avec.

Beaucoup de noms apparaissent sur les deux modèles. blendMode, texture, bindWeight, birthVelocity, particleLifetime et d'autres existent sur l'émetteur moderne et sur un composant legacy, à des offsets différents. Quand une valeur semble sans effet, vérifie lequel des deux tu es en train d'éditer.

Trois noms n'existent que sur le modèle legacy :

VfxEmitterLegacySimple porte aussi birthScale, scale, birthRotation, birthRotationalVelocity, rotation, scaleBias, orientation, fixedOrbitType, hasFixedOrbit et scaleUpFromOrigin. Note les birthScale et birthRotation sans suffixe ici, face à birthScale0 et birthRotation0 sur l'émetteur moderne.

Le pointeur LegacySimple est ce qu'utilisent les émetteurs de la liste simpleEmitterDefinitionData du système. Si un système remplit cette liste plutôt que complexEmitterDefinitionData, c'est ce bloc que lisent ses émetteurs.

Propriétés que l'émetteur a perdues

Quatre propriétés d'émetteur ont été retirées et n'apparaîtront que dans de vieux bins ou de vieilles documentations.

assetCategory a été retirée de VfxSystemDefinitionData au patch 14.15.

Ce qu'on interprète facilement de travers

Une courte liste des mauvaises lectures qui coûtent le plus de temps.

Les noms et types de cette page ont été lus dans la disposition de classes enregistrée par le moteur pour le patch 16.16. Si une propriété manque ou si une description est fausse, ça vaut le coup de la corriger : voir Comment contribuer.