fxAddWood | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

fxAddWood

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

Creates a wood splinter particle effect.

OOP Syntax Help! I don't understand this!

Syntax

bool fxAddWood ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [ int count = 1, float brightness = 1.0 ] )
Required Arguments
  • posX: MISSING_PARAM_DESC
  • posY: MISSING_PARAM_DESC
  • posZ: MISSING_PARAM_DESC
  • dirX: MISSING_PARAM_DESC
  • dirY: MISSING_PARAM_DESC
  • dirZ: MISSING_PARAM_DESC
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • count (default: 1): the number of splinters to create.
  • brightness (default: 1.0): the brightness. Ranges from 0 (black) to 1 (normal color).

Returns

  • bool: value

Returns a true if the operation was successful, false otherwise.

Code Examples

shared

This example will create a Wood Effect next to you when typing/woodfxin the Chatbox.

addCommandHandler("woodfx", function()
    local x, y, z = getElementPosition(localPlayer)
    local gz = getGroundPosition(x, y, z)
    fxAddWood(x, y, gz+0.4, 0, 0, 0, math.random(3, 6), 0.7)
end)

See Also

Effects Functions
Reference