Skip to main content

Special FX Reference

Billboard​

void Visible(bool value)​

  • Description: Sets whether the billboard is visible or not.

void LoadExternalTexture(string path, Vector2 ttile)​

  • Description: Loads a jpg/png file located in path, and repeats ttile on the component.

FX Elements (Explosion, Fire, Flame, Plasma, Smoke, Sparks, Shavings, Water)​

bool Visible​

  • Description: Activates the specific effect (Explosion, Fire, Flame, Plasma, Smoke, Sparks, Shavings, Water).

void SoundEnabled(bool v)​

  • Description: Enables/disables the effect sound.

bool BigExplosion (Explosion Only)​

  • Description: Sets whether the explosion is big (true) or small (false).

bool Embers / bool FireLight (Fire/Smoke Only)​

  • Description: Shows/Hides embers or light around the effect.

bool ElectricSparks (Sparks Only)​

  • Description: Sets the sparks type.

float WaterSize (Water Only)​

  • Description: Sets the water particles' size.

Text 3D​

string Text​

  • Description: Sets the text message.

Color TextColor​

  • Description: Sets the text color.

void Visible(bool value)​

  • Description: Views/hides the Text effect.

Cutter​

int CuttedWorkPart_ID​

  • Description: Gets/Sets the new ID for the workpart that is cut.

int DetectedWPType​

  • Description: Returns the WorkPart ID that collides with the cutting blade.

void Cut(float delay)​

  • Description: Makes the workpart cut (after passed delay seconds).

void ResetCut(float delay)​

  • Description: Resets the cutting (after passed delay seconds).

void ChangeTexture(string textName)​

  • Description: Changes the texture to be applied to the WorkPart cut.

Stamper​

void CreateStamp() / void CreateStamp(Color col)​

  • Description: Activates the stamp effect (with optional color).

Line​

float Width / Color LineColor​

  • Description: Sets/Gets the line width and color.

Vector3 Point1Pos / Vector3 Point2Pos​

  • Description: Sets/Gets the points' positions in local coordinates.

void Point1PosWorld(Vector3 position) / void Point2PosWorld(Vector3 position)​

  • Description: Sets the points' positions in world coordinates.

void Draw(Vector3 p1, Vector3 p2)​

  • Description: Draws the line between the passed points.

Special FX Container​

void Play() / void Stop() / bool Visible​

  • Description: Controls for the FX effect.

void Duration(float s)​

  • Description: Sets the duration in seconds for the FX effect.

void Emit(int n)​

  • Description: Emits the n number of particles.

void PlaySingleSound(string clip, float volume) / void PlayLoopSound(...)​

  • Description: Sound management for the effect position.

Shapes​

void Visible / Color LineColor / float LineWidth​

  • Description: Basic shape visibility and line properties.

float Radius / float StartAngle / float EndAngle​

  • Description: Parameters for circle and arc shapes.

float GridCellSize / Vector3 GridSize / bool GridFill​

  • Description: Parameters for grid shapes.

Vector3 StartPoint / EndPoint / CntrlPoint1 / CntrlPoint2​

  • Description: Coordinates for lines and splines (including control points).