fxAddWood

Client-side

Server-side

Shared

Creates a wood splinter particle effect.

OOP Syntax Help! I don't understand this!

Method:Effect.addWood(...)

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: The world X coordinate where the effect originates.
posY: The world Y coordinate where the effect originates.
posZ: The world Z coordinate where the effect originates.
dirX: The direction X coordinate of the effect.
dirY: The direction Y coordinate of the effect.
dirZ: The direction Z coordinate of the effect.

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: result

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

Code Examples

client

This example will create a Wood Effect next to you when typing /woodfx in 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)

Gallery

Click on the image to view the full preview along with the description.