Difference between revisions of "B2.ParticleSystem:createParticleGroup"

From GiderosMobile
(added example)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
<languages />
 
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
−
'''Class:''' [[Special:MyLanguage/b2.ParticleSystem|b2.ParticleSystem]]<br/>
+
'''Class:''' [[b2.ParticleSystem]]<br/>
  
 
=== Description ===
 
=== Description ===
−
Creates a group of multiple particles with same properties, that can be defined in table with:
+
Creates a group of multiple particles with the same properties.
−
*''flags''
+
<syntaxhighlight lang="lua">
−
*''groupFlags''
 
−
*''position''
 
−
*''angle''
 
−
*''linearVelocity''
 
−
*''angularVelocity''
 
−
*''color''
 
−
*''alpha''
 
−
*''strength''
 
−
*''shape''
 
−
*''lifetime''
 
−
<source lang="lua">
 
 
b2.ParticleSystem:createParticleGroup(particleGroupDef)
 
b2.ParticleSystem:createParticleGroup(particleGroupDef)
−
</source>
+
</syntaxhighlight>
 +
 
 +
The possible table properties are:
 +
*'''''flags''''': the particle-behavior flags
 +
*'''''groupFlags''''': the group-construction flags
 +
*'''''position''''': the world position of the group. Moves the group's shape a distance equal to the value of position
 +
*'''''angle''''': the world angle of the group in radians. Rotates the shape by an angle equal to the value of angle
 +
*'''''linearVelocity''''': the linear velocity of the group's origin in world co-ordinates
 +
*'''''angularVelocity''''': the angular velocity of the group
 +
*'''''color''''': the color of all particles in the group
 +
*'''''alpha''''': the alpha of all particles in the group
 +
*'''''strength''''': the strength of cohesion among the particles in a group with flag b2.ParticleSystem.FLAG_ELASTIC or b2.ParticleSystem.FLAG_SPRING
 +
*'''''shape''''': the shape where particles will be added
 +
*'''''lifetime''''': lifetime of the particle group in seconds. A value <= 0.0f indicates a particle group with infinite lifetime
  
 
=== Parameters ===
 
=== Parameters ===
−
'''particleGroupDef''': (table) table with particle group data <br/>
+
'''particleGroupDef''': (table) table with particle group data<br/>
  
 
=== Example ===
 
=== Example ===
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
require "liquidfun"
 
require "liquidfun"
 
local world = b2.World.new(0, 9.8)
 
local world = b2.World.new(0, 9.8)
Line 33: Line 34:
 
ps:setTexture(Texture.new("gfx/myparticle.png"))
 
ps:setTexture(Texture.new("gfx/myparticle.png"))
 
stage:addChild(ps)
 
stage:addChild(ps)
−
ps:createParticleGroup( { shape = shape, position = { x = 128, y = 128}, color = 0xffffff, alpha=1, flags=b2.ParticleSystem.FLAG_VISCOUS } )
+
ps:createParticleGroup({
−
</source>
+
shape = shape,
 +
position = { x = 128, y = 128},
 +
color = 0xffffff,
 +
alpha=1,
 +
flags=b2.ParticleSystem.FLAG_VISCOUS,
 +
})
 +
</syntaxhighlight>
  
 
{{B2.ParticleSystem}}
 
{{B2.ParticleSystem}}

Latest revision as of 05:58, 8 November 2024

Available since: Gideros 2011.6
Class: b2.ParticleSystem

Description

Creates a group of multiple particles with the same properties. 

b2.ParticleSystem:createParticleGroup(particleGroupDef)

The possible table properties are:

  • flags: the particle-behavior flags
  • groupFlags: the group-construction flags
  • position: the world position of the group. Moves the group's shape a distance equal to the value of position
  • angle: the world angle of the group in radians. Rotates the shape by an angle equal to the value of angle
  • linearVelocity: the linear velocity of the group's origin in world co-ordinates
  • angularVelocity: the angular velocity of the group
  • color: the color of all particles in the group
  • alpha: the alpha of all particles in the group
  • strength: the strength of cohesion among the particles in a group with flag b2.ParticleSystem.FLAG_ELASTIC or b2.ParticleSystem.FLAG_SPRING
  • shape: the shape where particles will be added
  • lifetime: lifetime of the particle group in seconds. A value <= 0.0f indicates a particle group with infinite lifetime

Parameters

particleGroupDef: (table) table with particle group data

Example

require "liquidfun"
local world = b2.World.new(0, 9.8)
local shape = b2.PolygonShape.new()
shape:setAsBox(128, 128)
local ps = world:createParticleSystem( { radius = 16 } )
ps:setTexture(Texture.new("gfx/myparticle.png"))
stage:addChild(ps)
ps:createParticleGroup({
	shape = shape,
	position = { x = 128, y = 128},
	color = 0xffffff,
	alpha=1,
	flags=b2.ParticleSystem.FLAG_VISCOUS,
})



LiquidFun

Retrieved from ‘https://wiki.gideros.rocks/index.php?title=B2.ParticleSystem:createParticleGroup&oldid=23953’