Bin & Particle Dictionary

Todas as outras páginas desta seção ensinam você a fazer alguma coisa. Esta é para o momento em que você está rolando um dump .py, esbarra numa propriedade que nunca viu e só quer saber o que ela é e onde fica.

As entradas estão agrupadas pela classe dona delas, porque num bin o mesmo nome pode aparecer em mais de uma classe, e saber em qual você está decide o que o valor faz.

Como ler um bin

Um bin de VFX é uma árvore. A espinha dorsal é assim:

VfxSystemDefinitionData              um efeito completo, por ex. um recall ou um Q
└── complexEmitterDefinitionData     a lista de emissores do sistema
    └── VfxEmitterDefinitionData     um emissor: um rastro, um flash, faíscas
        ├── primitive                o que cada partícula desenha
        └── ponteiros *Definition    erosão, paleta, distorção, filhos, ...

VfxSystemDefinitionData é o contêiner. Uma propriedade que não estiver dentro do sistema tocado durante uma habilidade não vai aparecer durante essa habilidade.

O emissor é onde você passa a maior parte do tempo. Ele carrega 135 campos registrados sozinho, e pendura uma dúzia de objetos de sub-definição opcionais em ponteiros. Um ponteiro nulo significa que aquele recurso inteiro está desligado, e é por isso que apagar um bloco costuma ser a forma correta de desativar alguma coisa.

Invólucros de valor

Propriedades numéricas costumam vir embrulhadas para que a engine possa mantê-las constantes ou variá-las:

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

Os invólucros são ValueFloat, ValueColor, ValueVector2 e ValueVector3. Cada um guarda um constantValue mais um ponteiro dynamics opcional. São dois campos separados, não duas grafias do mesmo campo: a constante está sempre lá, e dynamics é um objeto extra pendurado nela.

Propriedades de nascimento e seus pares ao longo da vida

Muitas propriedades vêm em pares. A de birth* é avaliada uma vez, quando a partícula nasce. A parceira sem o prefixo continua agindo ao longo da vida da partícula, e é multiplicada com o valor de nascimento em vez de substituí-lo.

Se um valor parece errado e só metade de um par está escrita, confira a outra metade antes de mudar qualquer coisa.

Unidades

Rotações e velocidades de rotação são em graus e graus por segundo. Tempos de vida, períodos e atrasos são em segundos. Velocidades de rolagem de UV são em UVs por segundo, e rotação de UV em graus. Canais de cor vão de 0 a 1.

Aleatorização e o sufixo 0

Várias propriedades de nascimento terminam em 0, como birthScale0 e birthRotation0. Isso é resquício de nomenclatura, não um par mínimo-máximo. Não existe birthScale1 na classe de emissor atual. A variação por partícula vem de probabilityTables, como acima.

Bytes de flags

Muitos booleanos não são campos separados. São bits isolados empacotados em bytes de flags compartilhados no emissor. Ferramentas de texto os expõem um a um como flag, então você escreve um de cada vez, mas eles vivem quatro ou oito por byte. A lista completa está em Flags do emissor.

Nível do sistema

VfxSystemDefinitionData, o contêiner mais externo. 33 campos registrados no patch 16.16.

Emissor: identidade e tempo de vida

VfxEmitterDefinitionData. Tudo daqui até Flags do emissor está nesta classe, a menos que uma linha diga o contrário.

Como importance faz o culling

importance é comparada com a configuração Qualidade dos efeitos do jogador quando o sistema monta seus emissores. É uma categoria, não uma escala, e dois dos valores se comportam de um jeito que o nome não sugere.

Então 0 a 3 sobem em prioridade, e 3 é crítico para a jogabilidade e nunca é cortado. 4 é um substituto de baixa qualidade mostrado só em configurações baixas, e 5 é o inverso, mostrado só de Média para cima. Parear um emissor 4 com um emissor 5 é como um efeito entrega duas versões de si mesmo.

Outras quatro coisas decidem se um emissor existe: disabled, colorblindVisibility, ChanceToNotExist e o bit 0x800 das flags do sistema, que remove tudo exceto importance 3 e 4.

rate, lifetime, particleLifetime e particleLinger aparecem com capturas de tela na página Emitter Library.

Emissor: emissão e tempo

Emissor: posicionamento e orientação

Emissor: propriedades de nascimento

O estado que a partícula recebe no instante em que nasce. Tudo chamado birth* é condição inicial, não contínua.

Cada uma tem uma irmã flex* (flexBirthVelocity, flexBirthUVOffset, flexScaleBirthScale e assim por diante) que a sobrescreve quando um valor flex é fornecido.

Emissor: movimento ao longo da vida

Onde birth* define o estado inicial, estas continuam agindo.

Emissor: cor

Lendo um valor RGBA

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

Os canais vão de 0 a 1 em vez de 0 a 255. Para converter, divida por 255. O canal verde acima é 180, e 180 / 255 dá 0.7059.

O quarto valor é o alfa, onde 0 é totalmente transparente e 1 totalmente opaco.

Para recolorir na prática, o Quartz faz as contas para você.

Emissor: textura e UV

Emissor: estado de renderização

Valores de blendMode

São fixos e iguais para todos os primitivos. Cada modo escolhe um fator de mistura de origem e destino e uma operação de mistura.

Lendo essa tabela na prática:

• 0 e 4 são os modos aditivos. O preto não contribui com nada, então são os seguros para recolorir na direção do preto.
• 1 é a mistura alfa padrão, o mais próximo de "normal".
• 2 escurece, já que multiplica pelo inverso da cor de origem.
• 3 é o modo opaco. É o único que escreve profundidade e o único que não mistura nada.
• 6 e 7 pegam o mínimo ou o máximo entre origem e destino em vez de somar.

Flags do emissor

Quatro bytes no emissor, cada um carregando até oito bits nomeados. Ferramentas de texto os expõem um a um como flag.

Primitivos

primitive é um ponteiro que decide o que cada partícula desenha. Deixá-lo vazio dá o quad billboard padrão voltado para a câmera.

Campos de mesh

Primitivos de mesh carregam um VfxMeshDefinitionData em mMesh. Repare nos prefixos m: eles não se escrevem como os campos próprios do emissor.

Primitivos de mesh também carregam AlignPitchToCamera e AlignYawToCamera em VfxPrimitiveMeshBase.

Tipos de arquivo de mesh

Um par .skn e .skl dentro de uma pasta de partículas significa uma mesh animada. Veja Meshes as Particles.

Rastro e fita

VfxPrimitiveTrailBase carrega um VfxTrailDefinitionData em mTrail:

VfxRibbonDefinitionData carrega birthTilingSize como ValueVector2.

Classes de sub-definição

Cada uma pende de um ponteiro no emissor. Nulo significa que o recurso está totalmente desligado.

Texture mult

VfxTextureMultDefinitionData. Uma segunda textura multiplicada sobre a base, a mesma ideia do Multiply num editor de imagem. O campo textureMult do emissor aponta para este objeto, e o nome de arquivo real é a string textureMult dentro dele.

Seu byte de flags carrega uvScrollAlphaMult, uvScrollClampMult, TextureMultFilpU, TextureMultFilpV e isRandomStartFrameMult. Esses dois últimos são escritos assim mesmo na engine, então procure por "Filp" e não "Flip" quando for atrás deles.

Paleta

VfxPaletteDefinitionData. Colore as partículas amostrando uma textura de gradiente em vez de usar um valor chapado.

Erosão de alfa

VfxAlphaErosionDefinitionData. Dissolve a partícula usando um mapa. É assim que praticamente todo efeito de queimar ou apagar é construído.

Um mapa de erosão costuma ser em tons de cinza, onde o branco erode primeiro e o preto por último. Mapas multicanal carregam um padrão independente por canal de cor, e erosionMapChannelMixer escolhe entre eles.

Distorção

VfxDistortionDefinitionData. Distorce o que é desenhado atrás da partícula. Ondas de choque e ondulação de calor.

Reflexo e fresnel

VfxReflectionDefinitionData. O bloco de contorno luminoso e reflexo. fresnel mora aqui, não no emissor.

Soft particles

VfxSoftParticleDefinitionData. Suaviza a emenda dura onde uma partícula cruza a geometria.

Há um quinto byte de modo escolhendo qual dos dois esmaecimentos se aplica. Um ponteiro softParticleParams nulo desliga o recurso por completo, e não existe campo liga/desliga separado.

Linger

VfxLingerDefinitionData. Altera a partícula durante a fase de permanência em vez de só atrasar sua remoção.

Cada uma tem uma flag Use* correspondente: UseLingerRotation, UseLingerScale, UseKeyedLingerVelocity, UseKeyedLingerAcceleration, UseKeyedLingerDrag e UseSeparateLingerColor. Definir o valor sem a flag não faz nada.

Materiais e drivers

VfxMaterialDefinitionData guarda um link Material e um mapa materialDrivers. Os drivers animam um parâmetro de material em vez de mantê-lo constante.

Para trabalho com glow e toon shader, veja Static Materials.

Campos de força

VfxFieldCollectionDefinitionData, alcançado pelo fieldCollectionDefinition do emissor. Onde birthVelocity põe uma partícula em movimento, um campo continua agindo sobre ela.

Formas de emissão

SpawnShape aponta para um IVfxShape.

VfxEmissionMeshData cuida do nascimento a partir de uma mesh, com meshName, skeletonName, AnimationName, meshScale, maxJointWeights, Submeshes e useSurfaceNormalForBirthPhysics.

Partículas filhas

VfxChildParticleSetDefinitionData, alcançado pelo childParticleSetDefinition do emissor. É assim que um rastro solta faíscas ou uma explosão joga destroços.

VfxChildIdentifier guarda effect (um link), effectKey (um hash) e effectName (uma string).

VfxParentInheritanceParams guarda Mode e RelativeOffset. Esse deslocamento é um canal relativo ao pai por direito próprio, separado do EmitterPosition do próprio filho.

Um padrão comum é um emissor pai usando VfxPrimitiveNonRenderable: ele não desenha nada e existe apenas para posicionar seus filhos.

O modelo de componentes legacy

Efeitos mais antigos usam um segundo modelo de emissor, baseado em componentes, que ainda vem na engine. Você vai encontrá-lo em campeões antigos. Está documentado aqui para você reconhecê-lo, não para escrever coisa nova com ele.

Muitos nomes aparecem nos dois modelos. blendMode, texture, bindWeight, birthVelocity, particleLifetime e outros existem no emissor moderno e num componente legacy, em offsets diferentes. Quando um valor parece não surtir efeito, veja qual dos dois você está editando de fato.

Três nomes existem apenas no modelo legacy:

VfxEmitterLegacySimple também carrega birthScale, scale, birthRotation, birthRotationalVelocity, rotation, scaleBias, orientation, fixedOrbitType, hasFixedOrbit e scaleUpFromOrigin. Repare no birthScale e birthRotation sem sufixo aqui, contra birthScale0 e birthRotation0 no emissor moderno.

O ponteiro LegacySimple é o que os emissores da lista simpleEmitterDefinitionData do sistema usam. Se um sistema preenche essa lista em vez de complexEmitterDefinitionData, é esse bloco que seus emissores leem.

Propriedades que o emissor perdeu

Quatro propriedades do emissor foram aposentadas e só vão aparecer em bins antigos ou documentação antiga.

assetCategory foi removida de VfxSystemDefinitionData no patch 14.15.

Coisas fáceis de entender errado

Uma lista curta das leituras equivocadas que mais custam tempo.

Os nomes e tipos desta página foram lidos do layout de classes registrado pela engine para o patch 16.16. Se faltar uma propriedade ou uma descrição estiver errada, vale corrigir: veja Como contribuir.