Class ParticleFormatUpgrader

Namespace: ValveResourceFormat.Particles.Upgrade
Assembly: ValveResourceFormat.dll

Replays the engine's vpcf KV3 format-conversion chain, upgrading particle system documents from their stored format to the newest implemented format.

public static class ParticleFormatUpgrader

Inheritance

object ← ParticleFormatUpgrader

Fields

LatestBehaviorVersion

The newest m_nBehaviorVersion the chain produces.

public const int LatestBehaviorVersion = 12

Field Value

int

Properties

LatestFormat

The newest format the chain produces. Definitions built in memory should declare this so the chain does not replay over content that is already current.

public static KV3ID LatestFormat { get; }

Property Value

KV3ID

Methods

UpgradeToLatest(KVObject, KV3ID?)

Deep-clones the given document root and applies every implemented chain step past the stored format, returning the upgraded clone. Missing and unknown formats start at the oldest step, matching the engine treating headerless data as oldest. The result is always a clone, so a caller that edits it never reaches the document it was given.

public static KVObject UpgradeToLatest(KVObject root, KV3ID? storedFormat)

Parameters

root KVObject

storedFormat KV3ID?

Returns

KVObject