modding:xml:effects
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
modding:xml:effects [2017/06/28 21:38] – Summary of all Effect types 0xabcdef | modding:xml:effects [2017/06/28 22:22] (current) – move to modding:xml:effecttype 0xabcdef | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | =====Summary===== | ||
- | * EffectType: If this contains an Effect or multiple subelements, | ||
- | * **UNID=** | ||
- | * **sound=** [Sound type] | ||
- | * **instance=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * 0 or 1 Effect | ||
- | * [All Subelements] | ||
- | * 0 or 1 Events | ||
- | * 0 or 1 GetParameters: | ||
- | * Beam | ||
- | * **beamType=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * **intensity=** [whole number] | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * Bolt | ||
- | * **length=** [whole number] | ||
- | * **width=** [whole number] | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * Damage: Contains the same attributes and subelements as a Weapon | ||
- | * Ellipse | ||
- | * **eccentricity=** [whole number] between 0 and 100. | ||
- | * **lineColor=** [hex color] | ||
- | * **lineStyle=** | ||
- | * " | ||
- | * " | ||
- | * **lineWidth=** [whole number] | ||
- | * **radius=** [whole number] | ||
- | * **rotation=** [whole number] degrees | ||
- | * Flare | ||
- | * **lifetime=** [whole number] | ||
- | * **radius=** [whole number] | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * **style=** | ||
- | * **" | ||
- | * **" | ||
- | * **" | ||
- | * Group: Same as Effect | ||
- | * Image | ||
- | * **imageID=** [Image type] Inherited from ImageDesc | ||
- | * **imageX=** [whole number] Inherited from ImageDesc | ||
- | * **imageY=** [whole number] Inherited from ImageDesc | ||
- | * **imageWidth=** [whole number] Inherited from ImageDesc | ||
- | * **imageHeight=** [whole number] Inherited from ImageDesc | ||
- | * **imageFrameCount=** [whole number] Inherited from ImageDesc | ||
- | * **imageTicksPerFrame=** [whole number] Inherited from ImageDesc | ||
- | * **lifetime=** [whole number] | ||
- | * **randomStartFrame=** [boolean] | ||
- | * **rotateImage=** [boolean] | ||
- | * **rotationCount=** [whole number] | ||
- | * **imageVariants=** [whole number] | ||
- | * ImageAndTail | ||
- | * **imageID=** [Image type] Inherited from ImageDesc | ||
- | * **imageX=** [whole number] Inherited from ImageDesc | ||
- | * **imageY=** [whole number] Inherited from ImageDesc | ||
- | * **imageWidth=** [whole number] Inherited from ImageDesc | ||
- | * **imageHeight=** [whole number] Inherited from ImageDesc | ||
- | * **imageFrameCount=** [whole number] Inherited from ImageDesc | ||
- | * **imageTicksPerFrame=** [whole number] Inherited from ImageDesc | ||
- | * **imageVariants=** [whole number] | ||
- | * **randomStartFrame=** [boolean] | ||
- | * **length=** [whole number] | ||
- | * **width=** [whole number] | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * ImageFracture | ||
- | * Image: Same as ImageDesc | ||
- | * **imageID=** [Image type] Inherited from ImageDesc | ||
- | * **imageX=** [whole number] Inherited from ImageDesc | ||
- | * **imageY=** [whole number] Inherited from ImageDesc | ||
- | * **imageWidth=** [whole number] Inherited from ImageDesc | ||
- | * **imageHeight=** [whole number] Inherited from ImageDesc | ||
- | * **imageFrameCount=** [whole number] Inherited from ImageDesc | ||
- | * **imageTicksPerFrame=** [whole number] Inherited from ImageDesc | ||
- | * LightningStorm | ||
- | * **intensity=** [whole number] | ||
- | * **lifetime=** [whole number] ticks | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * **style=** | ||
- | * "" | ||
- | * " | ||
- | * MoltenBolt | ||
- | * **length=** [whole number] | ||
- | * **width=** [whole number] | ||
- | * **growth=** [whole number] Length increase per tick for the first 8 ticks? | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * Null | ||
- | * Particle | ||
- | * **style=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * **minWidth=** [whole number] | ||
- | * **maxWidth=** [whole number] | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * ParticleCloud | ||
- | * **drag=** [integer] | ||
- | * **cohesion=** [whole number] between 0 and 100 | ||
- | * **emitDuration=** [whole number] must be less than **lifetime** | ||
- | * **emitRate=** [dice range] | ||
- | * **emitRotation=** [integer] | ||
- | * **emitSpeed=** [dice range] | ||
- | * **lifetime=** [dice range] | ||
- | * **particleCount=** [dice range] | ||
- | * **particleLifetime=** [dice range] | ||
- | * **radius=** | ||
- | * **ringWidth=** | ||
- | * **slowMotion=** [whole number] | ||
- | * **spreadAngle=** [dice range] | ||
- | * **style=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * **viscosity=** [whole number] between 0 and 100 | ||
- | * **wakePotential=** [whole number] between 0 and 100 | ||
- | * ParticleEffect: | ||
- | * ParticleExplosion | ||
- | * **particleCount=** | ||
- | * **particleSpeed=** | ||
- | * **particleLifetime=** | ||
- | * **lifetime=** | ||
- | * Image: Same as ImageDesc | ||
- | * **imageID=** [Image type] Inherited from ImageDesc | ||
- | * **imageX=** [whole number] Inherited from ImageDesc | ||
- | * **imageY=** [whole number] Inherited from ImageDesc | ||
- | * **imageWidth=** [whole number] Inherited from ImageDesc | ||
- | * **imageHeight=** [whole number] Inherited from ImageDesc | ||
- | * **imageFrameCount=** [whole number] Inherited from ImageDesc | ||
- | * **imageTicksPerFrame=** [whole number] Inherited from ImageDesc | ||
- | * ParticlePattern / ParticleComet | ||
- | * **jitterLength=** | ||
- | * **length=** | ||
- | * **lifetime=** | ||
- | * **particleCount=** | ||
- | * **particleSpeed=** | ||
- | * **primaryColor=** [hex color] | ||
- | * **secondaryColor=** [hex color] | ||
- | * **spreadAngle=** | ||
- | * **style=** | ||
- | * "" | ||
- | * " | ||
- | * " | ||
- | * **width=** | ||
- | * ParticleEffect: | ||
- | * ParticleSystem / ParticleJet | ||
- | * **cohesion=** | ||
- | * **curDirection=** | ||
- | * **emitChance=** | ||
- | * **emitRate=** | ||
- | * **emitSpeed=** | ||
- | * **emitLifetime=** | ||
- | * **fixedPos=** | ||
- | * **isTrackingObject=** | ||
- | * **particleLifetime=** | ||
- | * **radius=** | ||
- | * **spreadAngle=** | ||
- | * **lifetime=** | ||
- | * **style=** | ||
- | * **tangentSpeed=** | ||
- | * **useObjectCenter=** | ||
- | * **wakePotential=** | ||
- | * **xformRotation=** | ||
- | * **xformTime=** | ||
- | * ParticleEffect: | ||
- | * PlasmaSphere | ||
- | * **spikeCount=** | ||
- | * **spikeLength=** | ||
- | * **primaryColor=** | ||
- | * **radius=** | ||
- | * **secondaryColor=** | ||
- | * Polyflash | ||
- | * Ray | ||
- | * **animate=** | ||
- | * **animateOpacity=** | ||
- | * **blendMode=** | ||
- | * **intensity=** | ||
- | * **length=** | ||
- | * **lifetime=** | ||
- | * **primaryColor=** | ||
- | * **secondaryColor=** | ||
- | * **shape=** | ||
- | * **style=** | ||
- | * **width=** | ||
- | * **xformRotation=** | ||
- | * Sequencer: A sequence of simple effects | ||
- | * Shape | ||
- | * **blendMode=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * **scaleWidth=** | ||
- | * **scaleLength=** | ||
- | * **color=** | ||
- | * **opacity=** | ||
- | * **directional=** | ||
- | * **scaleWidthInc=** | ||
- | * **scaleLengthInc=** | ||
- | * Point | ||
- | * **x=** | ||
- | * **y=** | ||
- | * Shockwave | ||
- | * **blendMode=** | ||
- | * **fadeStart=** | ||
- | * **glowSize=** | ||
- | * **image=** | ||
- | * **intensity=** | ||
- | * **lifetime=** | ||
- | * **primaryColor=** | ||
- | * **secondaryColor=** | ||
- | * **speed=** | ||
- | * **style=** | ||
- | * **width=** | ||
- | * Image: Same as ImageDesc | ||
- | * SmokeTrail= | ||
- | * **lifetime=** | ||
- | * **spread=** | ||
- | * **emitDuration=** | ||
- | * **particleLifetime=** | ||
- | * **emitRate=** | ||
- | * **emitSpeed=** | ||
- | * **rotation=** | ||
- | * ParticleEffect: | ||
- | * Starburst | ||
- | * **spikeCount=** | ||
- | * **spikeLength=** | ||
- | * **primaryColor=** | ||
- | * **secondaryColor=** | ||
- | * **style=** | ||
- | * **ballLightning=** | ||
- | * **flare=** | ||
- | * **plain=** | ||
- | * **lightningStar=** | ||
- | * **morningStar=** | ||
- | * **lifetime=** | ||
- | * Text | ||
- | * **align=** | ||
- | * " | ||
- | * " | ||
- | * " | ||
- | * **font=** | ||
- | * **opacity=** | ||
- | * **primaryColor=** | ||
- | * **text=** | ||
- | * Variants: Effect varies based on a value. Subelements must have the attribute **maxValue** | ||
- | =====Overview===== | ||
- | An effect element is an element that defines how to paint something on the screen. For example, [[Weapon devices|weapons]] use an < | ||
- | |||
- | In all cases, an effect element contains 0 or more sub-elements called **painters**. Each **painter** defines a particular type of paint effect. For example, an < | ||
- | |||
- | Suggesstion for [[game/ | ||
- | |||
- | The following painters exist: | ||
- | ^new in 1.06^ | ||
- | |< | ||
- | ====< | ||
- | Version: **1.06 and above**. | ||
- | |||
- | **beamType= ** Choose from one of many styles (list taken from TSE\SFXBeam.cpp) | ||
- | |||
- | * laser | ||
- | * lightning | ||
- | * heavyblaster | ||
- | * starblaster | ||
- | * particle | ||
- | * greenparticle | ||
- | * blueparticle | ||
- | * blaster | ||
- | * greenlightning | ||
- | |||
- | |||
- | |||
- | **primaryColor= ** Hexidecimal for the primary color. | ||
- | |||
- | **secondaryColor= ** Hexidecimal for the secondary color. | ||
- | |||
- | **intensity= ** Increases beam width (discovered by Hatsya) | ||
- | | ||
- | |||
- | ====< | ||
- | |||
- | **length=** The length of the bolt in pixels. | ||
- | |||
- | **width=** The width of the bolt in pixels. | ||
- | |||
- | **primaryColor=** The primary color. | ||
- | |||
- | **secondaryColor=** The secondary color. | ||
- | |||
- | ====< | ||
- | |||
- | **style=** One of the following: | ||
- | |||
- | * fadingBlast | ||
- | |||
- | **radius=** The radius in pixels. | ||
- | |||
- | **lifetime=** The lifetime of the effect in ticks. | ||
- | |||
- | ====< | ||
- | |||
- | **imageID=** UNID of the image to use. | ||
- | |||
- | **imageX=** X-coordinate of the upper-left of the image to use. | ||
- | |||
- | **imageY=** Y-coordinate of the upper-left of the image to use. | ||
- | |||
- | **imageWidth=** Width of the image in pixels. | ||
- | |||
- | **imageHeight=** Height of the image in pixels. | ||
- | |||
- | **lifetime=** Ticks to show image. | ||
- | |||
- | **imageFrameCount=** Number of animation frames in the image. If the effect lasts longer than the number of frames then the animation starts again from the beginning. | ||
- | |||
- | **imageTicksPerFrame=** Ticks to show each frame (valid only if imageFrameCount is non-zero). | ||
- | |||
- | **randomStartFrame=** If **true**, then start at a random frame (valid only if imageFrameCount is non-zero). | ||
- | |||
- | **rotationCount=** Number of rotation frames. | ||
- | |||
- | ====< | ||
- | |||
- | Same attributes as < | ||
- | |||
- | **length=** Length of the tail in pixels. | ||
- | |||
- | **width=** Width of the tail in pixels. | ||
- | |||
- | **primaryColor=** Primary color of the tail. | ||
- | |||
- | **secondaryColor=** Secondary color of the tail. | ||
- | |||
- | ====< | ||
- | |||
- | **length=** Length of the bolt in pixels. | ||
- | |||
- | **width=** Width of the bolt in pixels. | ||
- | |||
- | **growth=** If non-zero, the length of the bolt will increase by this number of pixels on each tick (up to a maximum of 8 ticks). | ||
- | |||
- | **primaryColor=** Primary color of bolt. | ||
- | |||
- | **secondaryColor=** Secondary color of bolt. | ||
- | |||
- | ====< | ||
- | |||
- | This painter is used for weapons of type=particles. | ||
- | |||
- | **style=** One of: | ||
- | |||
- | * flame | ||
- | * plain | ||
- | * line | ||
- | * smoke | ||
- | |||
- | **minWidth=** The minimum width of the particle in pixels. | ||
- | |||
- | **maxWidth=** The maximum width of the particle in pixels. | ||
- | |||
- | **primaryColor=** The primary color of the particle. | ||
- | |||
- | **secondaryColor=** The secondary color of the particle. | ||
- | |||
- | ====< | ||
- | Version: **1.08 and above**. | ||
- | |||
- | This painter creates a cloud of particles with various shapes and behaviors. | ||
- | |||
- | **style=** One of: | ||
- | |||
- | * cloud | ||
- | * splash | ||
- | * jet | ||
- | * ring | ||
- | |||
- | **lifetime=** The lifetime of the effect in ticks (expressed as a [[modding/ | ||
- | |||
- | **emitDuration=** The amount of time during which the effect will create new particles. For immortal effects this is expressed as a number of ticks. For effects with a limited lifetime, this is expressed as a % of the total lifetime. | ||
- | |||
- | **emitRate=** The number of new particles to create per tick (expressed as a [[modding/ | ||
- | |||
- | **emitSpeed=** The speed of a newly created particle (as a percent of light speed, expressed as a [[modding/ | ||
- | |||
- | **particleCount=** The number of particles initially created; these will appear immediately when the effect starts. The position and velocity of the initially created particles depends on the style. This property is a [[modding/ | ||
- | |||
- | **particleLifetime=** The lifetime a particle in the cloud in ticks. A value of -1 means that particles live forever. This property is a [[modding/ | ||
- | |||
- | **radius=** For **cloud** effects, this is the maximum radius of the cloud. For **ring** effects this is the radius of the ring. (expressed in pixels). | ||
- | |||
- | **ringWidth=** For **ring** effects, this is the radius of the ring in pixels. | ||
- | |||
- | **cohesion=** This is a value from 0 to 100 specifying the cohesion of the particles. Higher values accelerate the particles towards the center of the effect. | ||
- | |||
- | **viscosity=** This is a value from 0 to 100 specifying the tendency of the particles to move out of their designated shape (either cloud or ring). With higher values, particles tend to stay within the effect' | ||
- | |||
- | **wakePotential=** This is a value from 0 to 100 specifying the tendency of the particles to be affected by objects (such as ships) moving through them. | ||
- | |||
- | **< | ||
- | |||
- | ====< | ||
- | |||
- | **width=** Width of the comet in pixels. | ||
- | |||
- | **length=** Length of the comet in pixels. | ||
- | |||
- | **particleCount=** Number of particles in the comet. | ||
- | |||
- | **primaryColor=** Primary color of the particles. | ||
- | |||
- | ====< | ||
- | |||
- | **particleCount=** The number of particles in the explosion (this is a [[modding/ | ||
- | |||
- | **particleSpeed=** The speed of each particle in % of light-speed. | ||
- | |||
- | **particleLifetime=** The lifetime of each particle (in ticks). | ||
- | |||
- | **lifetime=** The lifetime of the effect (expressed as a [[modding/ | ||
- | |||
- | **< | ||
- | |||
- | ====< | ||
- | |||
- | **spikeCount=** The number of spikes, expressed as a [[modding/ | ||
- | |||
- | **spikeLength=** The length of each spike, in pixels, expressed as a [[modding/ | ||
- | |||
- | **primaryColor=** The primary color of the sphere. | ||
- | |||
- | **secondaryColor=** The secondary color of the sphere. | ||
- | |||
- | ====< | ||
- | This painter paints a muzzle-flash. It has no attributes. | ||
- | |||
- | ====< | ||
- | This painter draws a filled polygon defined by the < | ||
- | |||
- | **width=** The width of the polygon in pixels | ||
- | |||
- | **length=** The length of the polygon in pixels. | ||
- | |||
- | **widthInc=** Each tick, the width is increased by this number of pixels. | ||
- | |||
- | **lengthInc=** Each tick, the length is increased by this number of pixels. | ||
- | |||
- | **color=** The color of the polygon. | ||
- | |||
- | **opacity=** The opacity of the polygon (0 = transparent; | ||
- | |||
- | **directional=** If **true**, then the polygon is oriented along the appropriate direction (e.g., the direction in which the projectile was fired). | ||
- | |||
- | ===< | ||
- | The < | ||
- | |||
- | **x=** The // | ||
- | |||
- | **y=** The // | ||
- | |||
- | <Point x=" | ||
- | <Point x=" | ||
- | <Point x=" | ||
- | <Point x=" | ||
- | |||
- | The < | ||
- | |||
- | ====< | ||
- | |||
- | **style=** One of the following: | ||
- | |||
- | * glowRing | ||
- | * image | ||
- | |||
- | **speed=** The speed with which the shockwave expands (as % of light-speed). | ||
- | |||
- | **lifetime=** The lifetime of the shockwave in ticks. | ||
- | |||
- | **fadeStart=** The point at which the shockwave begins to fade (expressed as a percent of lifetime). | ||
- | |||
- | ===style=glowRing=== | ||
- | This style paints an expanding, glowing ring. It includes the following attributes: | ||
- | |||
- | **primaryColor=** The primary color of the ring. | ||
- | |||
- | **secondaryColor=** The secondary color of the ring. | ||
- | |||
- | **width=** The width of the ring in pixels (i.e., the thickness of the ring). | ||
- | |||
- | **glowWidth=** The width of the glowing part of the ring in pixels (generally greater than the width). | ||
- | |||
- | ===style=image=== | ||
- | This style using an image to paint the shockwave. | ||
- | |||
- | **< | ||
- | |||
- | ====< | ||
- | |||
- | **lifetime=** The lifetime of the effect in ticks. | ||
- | |||
- | **spread=** The width of the particle spray (expressed as units proportional to the angular spread). This is a [[modding/ | ||
- | |||
- | **emitDuration=** The amount of time that new particles are being emitted (expressed as a percentage of total lifetime). | ||
- | |||
- | **emitRate=** The number of particles emitted on each tick. This is a [[modding/ | ||
- | |||
- | **emitSpeed=** The speed of each particle, as a percent of light-speed. This is a [[modding/ | ||
- | |||
- | **particleLifetime=** The lifetime (in ticks) of an individual particle expressed as a [[modding/ | ||
- | |||
- | **< | ||
- | |||
- | ====< | ||
- | |||
- | **style=** One of the following: | ||
- | |||
- | * flare | ||
- | * lightningStar | ||
- | * morningStar | ||
- | * plain | ||
- | |||
- | **lifetime=** The lifetime of the effect in ticks. | ||
- | |||
- | **spikeCount=** The number of spikes to paint (this is a [[modding/ | ||
- | |||
- | **spikeLength=** The length of each spike in pixels (this is a [[modding/ | ||
- | |||
- | **primaryColor=** The primary color. | ||
- | |||
- | **secondaryColor=** The secondary color. | ||
- | ==== Suggested Colors ==== | ||
- | (Taken from [[http:// | ||
- | Lasers: red, green, or purple (in ascending order of strength)\\ | ||
- | Kinetic: gray \\ | ||
- | Particle: green, with particulate texture\\ | ||
- | Blast: flame \\ | ||
- | Ion: cyan\\ | ||
- | Thermo: flame/ | ||
- | Positron: yellow, with particulate texture \\ | ||
- | Plasma: yellow \\ | ||
- | Antimatter: yellow\\ | ||
- | Nano: various (gray/ | ||
- | Graviton: purple/ | ||
- | Singularity: | ||
- | Dark Acid: teal\\ | ||
- | Dark Steel: gray-green\\ | ||
- | Dark Lightning: blue \\ | ||
- | Dark Fire: red\\ | ||
- | \\ | ||
- | For lasers, we should probably avoid yellow and blue (to avoid confusion with positron/ | ||
- | =====API 20 (1.3 Beta 1 )===== | ||
- | From [[http:// | ||
- | Beam types | ||
- | < | ||
- | lightning | ||
- | lightningBolt | ||
- | heavyblaster | ||
- | greenparticle | ||
- | blueparticle | ||
- | blaster | ||
- | starblaster | ||
- | greenlightning | ||
- | jaggedBolt | ||
- | </ | ||
- | Ray types | ||
- | < | ||
- | fade | ||
- | diamond | ||
- | oval | ||
- | straight | ||
- | tapered | ||
- | cone | ||
- | wavy | ||
- | smooth | ||
- | jagged | ||
- | grainy | ||
- | </ | ||
- | ====No Hiteffects==== | ||
- | Source: http:// | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
modding/xml/effects.1498685934.txt.gz · Last modified: 2017/06/28 21:38 by 0xabcdef