FxAddBlood: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
 
[[Image:Fxblood.png|thumb|200px|Blood splatter]]
Creates a blood splatter particle effect.
Creates a blood splatter particle effect.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool fxAddBlood ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [int count=1, float brightness=1.0] )
bool fxAddBlood ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ [, int count = 1, float brightness = 1.0 ] )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Effect]].addBlood}}


===Required Arguments===
===Required Arguments===
Line 14: Line 15:


===Optional Arguments===
===Optional Arguments===
*'''count:''' the number of effects to create.
{{OptionalArg}}
*'''brightness:''' the brightness. Ranges from 0 to 1.
*'''count:''' the number of flying droplets to create.
*'''brightness:''' the brightness. Ranges from 0 (almost black) to 1 (normal color).
 
==Example==
<section name="Client" class="client" show="true">
This example creates blood effects when a player gets shot.
<syntaxhighlight lang="lua">
function BloodonDamage( attacker, weapon, bodypart, loss )
  if loss > 25 then -- if the player loses more than 25 hp, then...
      local x, y, z = getElementPosition( source ) -- get player's position for adding blood
      local randombloodamount = math.random( 1, 3 ) -- random blood amount 1-3
      fxAddBlood ( x, y, z-2, 0.00000, 0.00000, 0.00000, randombloodamount, 1 )
      -- this adds blood to player's current position
  end
end
addEventHandler( "onClientPlayerDamage", root, BloodonDamage ) -- calls the function when a player loses hp
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client Effects functions}}
{{Client Effects functions}}
[[ru:FxAddBlood]]

Latest revision as of 10:01, 21 June 2019

Blood splatter

Creates a blood splatter particle effect.

Syntax

bool fxAddBlood ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ [, int count = 1, float brightness = 1.0 ] )

OOP Syntax Help! I don't understand this!

Method: Effect.addBlood(...)


Required Arguments

  • posX, posY, posZ: the world coordinates where the effect originates.
  • dirX, dirY, dirZ: a direction vector indicating where the blood flies 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 flying droplets to create.
  • brightness: the brightness. Ranges from 0 (almost black) to 1 (normal color).

Example

Click to collapse [-]
Client

This example creates blood effects when a player gets shot.

function BloodonDamage( attacker, weapon, bodypart, loss )
   if loss > 25 then -- if the player loses more than 25 hp, then...
      local x, y, z = getElementPosition( source ) -- get player's position for adding blood
      local randombloodamount = math.random( 1, 3 ) -- random blood amount 1-3
      fxAddBlood ( x, y, z-2, 0.00000, 0.00000, 0.00000, randombloodamount, 1 )
      -- this adds blood to player's current position
   end
end
addEventHandler( "onClientPlayerDamage", root, BloodonDamage ) -- calls the function when a player loses hp

See Also