Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

DKC:TF > Particle File (GENP/SWSH/XFRM)

Meta data: NParticleFormat::SMetaData

TypeDescription
CFormDescriptorForm descriptor (GENP/SWSH/XFRM)

GENP/SWSH/XFRM Form

Version: 15

TypeDescription
CChunkDescriptorDESC chunk (particle generator description)

DESC Chunk

Version: 0

TypeDescription
CAssetHeaderAsset header
Parse tree

In the parse tree, every element starts with a CFourCC that indicates its type, followed by type-specific fields. Depending on the file type, the root element is either a GPSM, SWSH or XFRM node.

All elements have a fixed number of fields, except the root node which can have an arbitrary number of fields.

GPSM Node

This element contains an arbitrary number of elements of the following types.

Class idTypeDescription
ADV1
ADV2
ADV3
ADV4
ADV5
ADV6
ADV7
ADV8
ADV9
ALSC
CAV0
CAV1
CAV2
CAV3
CIND
COLR
DBIS
DBPS
DBSO
DDIT
DEFX
DFLG
DFOG
EMTE
EMTREmitter elementParticle emitter
EMTU
FXBI
FXBM
FXBO
FXBR
FXBT
GRTEReal elementParticle generation rate
IAV0
IAV1
IAV2
IAV3
INDM
INDP
INTP
INTR
INTS
INTT
ISTR
ISVF
ITPE
IVSE
KSSM
LCLR
LDIR
LFOR
LFOT
LINT
LIT_
LOFF
LSLA
LSNM
LTMEInt elementParticle lifetime
LTYP
MAXPInt elementMaximum number of particles
NTIK
ONET
ORNT
ORTC
PBDM
PMDL
PMLT
PMOO
PMOP
PMOV
PMPV
PMRB
PMRQ
PMRT
PMSC
PMUS
PSLTInt elementParticle system lifetime
PSTP
PSTS
PSWT
PWGT
RAV0
RAV1
RDOP
ROTA
RSV0
RSV1
RSV2
RSV3
SAXS
SBIS
SCNV
SCTR
SCX0
SEED
SIZE
SORT
SPCL
SSZE
SPWR
SPWS
SPWT
SSWT
SSZE
SVC0
SVC1
SVI0
SVI1
SVR0
SVR1
SVR2
SVR3
SVR4
SVV0
SVV1
SVV2
SVV3
SVV4
SYSR
SYSS
SYST
TEMR
TEMT
TEXR
TIND
TNML
TSPH
UDLS
UGFP
VAV1
VAV2
VAV3
VAV4
VEL1
VEL2
VEL3
VEL4
VGD1
VGD2
VGD3
VGD4
VMD1
VMD2
VMD3
VMD4
VMPC
VSPC
WSTP
XFMD
XTAD
ZBUF
_END

Bool Element

Note: in some cases, only CNST is accepted.

Class idDescription
CNSTConstant
EQULEquality check
LTHNLess than check
MIRRIs mirrored
NEXT
NORMIs vector normalizable
P50HAre we 50 Hz PAL
PEXT
VEXT

CBEConstant (CNST)

This element defines a constant.

TypeDescription
BoolValue

CBERealEqual (EQUL)

This element performs an equality check.

TypeDescription
Real elementLHS
Real elementRHS

CBERealLessThan (LTHN)

This element performs a less-than check.

TypeDescription
Real elementLHS
Real elementRHS

CBEMirrored (MIRR)

The value of this element is true if the mirror is enabled.

CBENormalizeable (NORM)

The value of this element is true if the given vector is normalizable.

TypeDescription
Vector elementVector

CBEAreWePal50 (P50H)

The value of this element is true if 50 Hz PAL is enabled.

Int Element

Class idDescription
ADD_Addition
BNIDBone index
CHANTime chain
CLMPClamp
CNSTConstant
DETHDeath
DIVDDivide
GAPCActive particle count
GEMTEmitter time
GTCPTotal created particle count
ILPT
IMPLImpulse
IRNDInitial random
ISWTInitial switch
KEYE
KEYF
KEYP
KPINKeep initial
MODUModulus
MULTMultiply
PAP0Context 2 variable 0
PAP1Context 2 variable 1
PAP2Context 2 variable 2
PAP3Context 2 variable 3
PCRTParticle creation time
PDETParticle creation time
PSA0Context 0 variable 0
PSA1Context 0 variable 1
PSI0Context 0 variable 0
PSI1Context 0 variable 1
PULSPulse
RANDRandom
RTOIReal to int
SUB_Subtract
TSCLTimescale

CIEAdd (ADD_)

TypeDescription
Int elementLHS
Int elementRHS

CIEBoneIndex (BNID)

TypeDescription
Uint32Unknown
StringJoint name
Uint32Unknown
BoolUnknown

CIETimeChain (CHAN)

TypeDescription
Int elementUnknown
Int elementUnknown
Int elementUnknown

CIEClamp (CLMP)

TypeDescription
Int elementUnknown
Int elementUnknown
Int elementUnknown

CIEConstant (CNST)

TypeDescription
Uint32Value

CIEDeath (DETH)

TypeDescription
Int elementUnknown
Int elementUnknown

CIEDivide (DIVD)

TypeDescription
Int elementLHS
Int elementRHS

CIEGetActiveParticleCount (GAPC)

The value of this element is the number of active particles.

CIEEmitterTime (GEMT)

The value of this element is the emitter time.

CIEGetTotalCreatedParticleCount (GTCP)

The value of this element is the total number of particles that were created.

CIEImpulse (IMPL)

TypeDescription
Int elementUnknown

CIEInitialSwitch (ISWT)

TypeDescription
Int elementUnknown
Int elementUnknown

CIEKeepInitial (KPIN)

TypeDescription
Int elementUnknown

CIEModulus (MODU)

TypeDescription
Int elementLHS
Int elementRHS

CIEMultiply (MULT)

TypeDescription
Int elementLHS
Int elementRHS

CIEParticleCreationTime (PCRT)

The value of this element is the particle creation time.

CIEParticleCreationTime (PDET)

The value of this element is the particle creation time.

CIEPulse (PULS)

TypeDescription
Int elementUnknown
Int elementUnknown
Int elementUnknown
Int elementUnknown

CIERandom (RAND)

TypeDescription
Int elementMinimum
Int elementMaximum

CIESubtract (SUB_)

TypeDescription
Int elementLHS
Int elementRHS

CIETimescale (TSCL)

TypeDescription
Real elementUnknown

Real Element

Class idDescription
ADD_Addition
CEQL
CEXT
CHANTime chain
CLMP
CLTN
CNSTConstant
CREL
CRNG
DIVD
DOTPDot product
GTCA
GTCB
GTCG
GTCP
GTCR
IRND
ISWT
ITRL
KEYE
KEYF
KEYP
KPIN
LFTW
MAXV
MINV
MULTMultiplication
MULV
NEXT
OCSP
PAP1
PAP2
PAP3
PAP4
PAP5
PAP6
PAP7
PAP8
PAP9
PEXT
PNO1
PNO2
PNO3
PNO4
PRLW
PRN1
PRN2
PRN3
PRN4
PSA0
PSA1
PSA2
PSLL
PSSZ
PULS
RANDRandom
RECPReciprocal
RLPT
SCAL
SINE
SUB_Subtraction
TOCS
VMAG
VXTR
VYTR
VZTR

CREConstant (CNST)

TypeDescription
FloatValue

CRERandom (RAND)

TypeDescription
Real elementBase
Real elementSpan

Vector Element

Class idDescription
ADD_
AEXT
ANGC
BNPS
BNSC
CCLU
CHAN
CIRC
CMPS
CNSTConstant
CONE
CRSS
CTVC
CVEC
EXTS
EXTT
INTS
INTT
IRTV
ISWT
KEYE
KEYF
KEYP
KPIN
MULT
NEXT
NONE
NORM
ORDR
PAP1
PAP2
PAP3
PAP4
PEXT
PLCO
PLOC
PNCV
PSA0
PSA1
PSA2
PSA3
PSA4
PSOF
PSOR
PSOU
PSTR
PULS
PVEL
RNDV
ROTV
RTOV
SCLE
SLOC
SPNT
SPSS
SUB_
VEXT

CVEConstant (CNST)

Emitter Element

Class idDescription
ASPHAngle sphere
ELPSEllipsoid
NONENone
PLNEPlane
SEMRSimple emitter
SPHESphere

CVEAngleSphere (ASPH)

TypeDescription
Vector elementUnknown
Real elementUnknown
Real elementUnknown
Real elementUnknown
Real elementUnknown
Real elementUnknown
Real elementUnknown

NParticleFormat::SMetaData

TypeDescription
List<CObjectTag>Texture references