FxAddWood: Difference between revisions

Revision as of 12:48, 25 May 2012

Wood

Creates a wood splinter particle effect.

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, posY, posZ: the world coordinates where the effect originates.
dirX, dirY, dirZ: a direction vector indicating where the wood splinters fly to.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

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

Returns

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

Example

Click to collapse [-]

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)

@@ Line 22: / Line 22: @@
 ==Example==
-This page lacks an example
+<section name="Client" class="client" show="true">
+This example will create a Wood Effect next to you when typing ''/woodfx'' in the Chatbox.
 <syntaxhighlight lang="lua">
---add an example here
+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)
 </syntaxhighlight>
+</section>
 ==See Also==
 {{Client Effects functions}}
-[[Category:Needs_Example]]