Latest version | 1.0.1 |
---|---|
Minimum Core | |
Compatible Core | |
Last updated | 1 day ago |
Created | 1 month ago |
Authors | |
Languages |
English Français |
Systems | All systems |
Project source | Project URL |
Parameter name | Accepted value | Description | Default value |
target | Placeable object id or an object with x and y attributes with default pattern inside | The target of the emission, it use to change the angle of the direction and prolonge lifetime of the particules | undefined |
positionSpawning | Object with x and y attributes with default pattern inside | Gap coordinate between source and the real position spawning of the particule (in px) | {x:0,y:0} |
particuleAngleStart | Default pattern | Direction of the particule at the spawning (in degree) | '0_360' |
particuleAngleEnd | Default pattern | Direction of the particule at his end (in degree) | undefined |
To emit particules from a choosen tile direct to a specific token with a constant velocity of 100 px/s
particuleEmitter.gravitateParticules
with an input that contains the default parameters and following ones :In this method the particuleVelocityStart and the particuleVelocityEnd are angular velocities (degree/sec)
Parameter name | Accepted value | Description | Default value |
particuleAngleStart | Default pattern | Angle where the particule spawn (in degree) | '0_360' |
particuleRadiusStart | Default pattern | Distance between particule and source at the spawning (in px) | '100%' |
particuleRadiusEnd | Default pattern | Distance between particule and source at his end (in px) | '50%' |
onlyEmitterFollow | boolean | If true only new particule is emit from the new position of the source if it move | false |
To emit particules graviting around a choosen token and ending at his center. The living particules will not move with the tokenparticuleEmitter.gravitateParticules({source : token.id , particuleRadiusStart : '200%', particuleRadiusEnd : 5, onlyEmitterFollow : true})
particuleEmitter.missileParticules
with a same input as Spray particule with a nested object subParticules
containing another input (spray or graviting) and type (equals to "Spraying" or "Graviting").To emit a missile particule with graviting sub particules that forming a trailparticuleEmitter.missileParticules({source : {x:200, y:250} , target: token.id, subParticules : { type: "Graviting", particuleLifetime: 1000, onlyEmitterFollow : true, particuleAngleStart: '0_360'}})
Notice that if the value XXXend is not given, but the value XXXstart is given, the start value overrides the default end value.
Parameter name | Accepted value | Description | Default value |
source | Placeable object id or an object with x and y attributes with default pattern inside | Source of the emission if it's a placeable object id, the source is the center of the object and it follow the object | {x:0,y:0} |
maxParticules | Number | Max particule allow at the same time for the emitter, if exceed we waiting for a particule to end before emitting another one | 1000 |
spawningFrequence | Number | Frequence between each emission | 3 |
spawningNumber | Number | Number of particule emit at during each frequence | 1 |
emissionDuration | Number | End particule emission at the end of the duration | undefined (loop infinitely) |
particuleVelocityStart | Default pattern | Velocity of the particule at the spawning (in px/sec) | 200% |
particuleVelocityEnd | Default pattern | Velocity of the particule at his end (in px/sec) | 50% |
particuleSizeStart | Default pattern of number or object with x and y | Size of the particule at the spawning (in px) | 10 |
particuleSizeEnd | Default pattern of number or object with x and y | Size of the particule at his end (in px) | '10_25' |
particuleRotationStart | Default pattern | Rotation of the particule at the spawning (in degree) | 0 |
particuleRotationEnd | Default pattern | Rotation of the particule at his end (in degree) | 0 |
particuleLifetime | Default pattern | Duration of each particule (in millisec) | [3500,4500] |
particuleColorStart | Object with x, y and z attributes with default pattern between 0 and 255 | Color of the particule at the spawning (in rgb (0 to 255)) | {x:250,y:250, z: 50} |
particuleColorEnd | Object with x, y and z attributes with default pattern between 0 and 255 | Color of the particule at his end (in rgb (0 to 255)) | {x:250,y:'50_100', z: 0} |
alphaStart | Default pattern between 0 and 1 | Alpha color of the particule at the spawning | 1 |
alphaEnd | Default pattern between 0 and 1 | Alpha color of the particule at his end | 0 |
vibrationAmplitudeStart | Default pattern | Amplitude of vibration in perpendicular direction of velocity at the spawning (in px) | 0 |
vibrationAmplitudeEnd | Default pattern | Amplitude of vibration in perpendicular direction of velocity at his end (in px) | 0 |
vibrationFrequencyStart | Default pattern | Frequence of vibration in perpendicular direction of velocity at the spawning (in milli-sec) | 0 |
vibrationFrequencyEnd | Default pattern | Frequence of vibration in perpendicular direction of velocity at his end (in milli-sec) | 0 |
particuleEmitter.sprayParticules('prefillMotionTemplate', 'prefillColorTemplate', {position: {x:100, y:'50_100'}})
is the same as particuleEmitter.sprayParticules('prefillColorTemplate', {position: {x:100, y:'50_100'}}, 'prefillMotionTemplate')
/pfx spray ray death
To stop a command, you can add the param *--instant* to not have to wait the end of the particules lifetime.
Measured template type | Positive velocity | Null velocity | Negative Velocity |
Circle | Emit from the center to the outside of the circle | Emit from the outside to the center of the circle | Appear everywhere in the circle |
Cone | Emit from the center to the outside of the cone | Emit from the outside to the center of the cone | Appear every where in the cone |
Rectangle | Emit from the center to the outside of the rectangle | Emit from the outside to the center of the rectangle | Appear every where in the rectangle |
Ray | Emit from the source to the opposite of the ray | Emit from the sopposite to the source of the ray | Appear every where in the ray |
To install this package, open your Foundry Setup screen and navigate to your Module tab and click the Install Module button.
From there, you can either search for the package unique name: particule-fx or copy its manifest URL:
And paste it to the input box at the bottom of your window.
You can install this package directly to your Forge account.
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Advertisement cookies are used to deliver visitors with customized advertisements based on the pages they visited before and analyze the effectiveness of the ad campaign.