Travis CI: API documentation update at 2014-06-18 19:00:44 UTC.

[ci package]

Docs/AngelScriptAPI.h

@@ -6201,6 +6201,72 @@ String typeName;
 int weakRefs;
 };
 
+class ParticleEffect
+{
+// Methods:
+ColorFrame GetColorFrame(uint) const;
+TextureFrame GetTextureFrame(uint) const;
+bool Load(File);
+bool Load(VectorBuffer&);
+bool Save(File) const;
+bool Save(VectorBuffer&) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+void SetColorFrame(uint, ColorFrame) const;
+void SetTextureFrame(uint, TextureFrame) const;
+
+// Properties:
+float activeTime;
+float animationLodBias;
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+Vector3 constantForce;
+float dampingForce;
+Vector3 emitterSize;
+EmitterType emitterType;
+float inactiveTime;
+Material material;
+Vector3 maxDirection;
+float maxEmissionRate;
+Vector3 maxParticleSize;
+float maxRotation;
+float maxRotationSpeed;
+float maxTimeToLive;
+float maxVelocity;
+/* readonly */
+uint memoryUse;
+Vector3 minDirection;
+float minEmissionRate;
+Vector2 minParticleSize;
+float minRotation;
+float minRotationSpeed;
+float minTimeToLive;
+float minVelocity;
+String name;
+/* readonly */
+uint numColorFrames;
+uint numParticles;
+/* readonly */
+uint numTextureFrames;
+/* readonly */
+int refs;
+bool relative;
+bool scaled;
+float sizeAdd;
+float sizeMul;
+bool sorted;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+bool updateInvisible;
+/* readonly */
+uint useTimer;
+/* readonly */
+int weakRefs;
+};
+
 class ParticleEffect2D
 {
 // Methods:
@@ -6234,6 +6300,8 @@ class ParticleEmitter
 {
 // Methods:
 void ApplyAttributes();
+void ApplyEffect();
+void Commit();
 void DrawDebugGeometry(DebugRenderer, bool);
 Variant GetAttribute(const String&) const;
 ValueAnimation GetAttributeAnimation(const String&) const;
@@ -6243,7 +6311,6 @@ Variant GetAttributeDefault(const String&) const;
 bool IsInView(Camera) const;
 bool Load(File, bool = false);
 bool Load(VectorBuffer&, bool = false);
-bool Load(XMLFile);
 bool LoadXML(const XMLElement&, bool = false);
 void MarkNetworkUpdate() const;
 void Remove();
@@ -6254,17 +6321,14 @@ void ResetEmissionTimer();
 void ResetToDefault();
 bool Save(File) const;
 bool Save(VectorBuffer&) const;
-bool Save(XMLFile);
 bool SaveXML(XMLElement&) const;
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
 bool SetAttribute(const String&, const Variant&);
 void SetAttributeAnimation(const String&, ValueAnimation, WrapMode = WM_LOOP, float = 1.0f);
 void SetAttributeAnimationSpeed(const String&, float);
 void SetAttributeAnimationWrapMode(const String&, WrapMode);
-void SetColor(const Color&);
 
 // Properties:
-float activeTime;
 bool animationEnabled;
 float animationLodBias;
 /* readonly */
@@ -6275,19 +6339,14 @@ Array<Variant> attributes;
 /* readonly */
 ShortStringHash baseType;
 /* readonly */
+Array<Billboard> billboards;
+/* readonly */
 BoundingBox boundingBox;
 bool castShadows;
 /* readonly */
 String category;
-/* readonly */
-Array<ColorFrame> colors;
-Vector3 constantForce;
-float dampingForce;
 float drawDistance;
-/* writeonly */
-float emissionRate;
-Vector3 emitterSize;
-EmitterType emitterType;
+ParticleEffect effect;
 bool emitting;
 bool enabled;
 /* readonly */
@@ -6297,62 +6356,31 @@ FaceCameraMode faceCameraMode;
 uint id;
 /* readonly */
 bool inView;
-float inactiveTime;
 uint lightMask;
 float lodBias;
 Material material;
-Vector3 maxDirection;
-float maxEmissionRate;
 uint maxLights;
-Vector3 maxParticleSize;
-float maxRotation;
-float maxRotationSpeed;
-float maxTimeToLive;
-float maxVelocity;
-Vector3 minDirection;
-float minEmissionRate;
-Vector2 minParticleSize;
-float minRotation;
-float minRotationSpeed;
-float minTimeToLive;
-float minVelocity;
 /* readonly */
 Node node;
 /* readonly */
 uint numAttributes;
-uint numColors;
+uint numBillboards;
 uint numParticles;
-uint numTextureFrames;
 ObjectAnimation objectAnimation;
 bool occludee;
 bool occluder;
-/* writeonly */
-Vector2 particleSize;
 /* readonly */
 int refs;
 bool relative;
-/* writeonly */
-float rotation;
-/* writeonly */
-float rotationSpeed;
 bool scaled;
 float shadowDistance;
 uint shadowMask;
-float sizeAdd;
-float sizeMul;
 bool sorted;
 bool temporary;
 /* readonly */
-Array<TextureFrame> textureFrames;
-/* writeonly */
-float timeToLive;
-/* readonly */
 ShortStringHash type;
 /* readonly */
 String typeName;
-bool updateInvisible;
-/* writeonly */
-float velocity;
 uint viewMask;
 /* readonly */
 int weakRefs;

Docs/LuaScriptAPI.dox

@@ -3282,117 +3282,132 @@ Properties:
 - unsigned checksum (readonly)
 - bool compressed (readonly)
 
-### ParticleEffect2D : Resource
-
-### ParticleEmitter : BillboardSet
+### ParticleEffect : Resource
 
 Methods:
 
-- bool Load(XMLFile* file)
-- bool Save(XMLFile* file)
+- void SetMaterial(Material* material)
 - void SetNumParticles(unsigned num)
-- void SetEmissionRate(float rate)
-- void SetMinEmissionRate(float rate)
-- void SetMaxEmissionRate(float rate)
+- void SetUpdateInvisible(bool enable)
+- void SetRelative(bool enable)
+- void SetScaled(bool enable)
+- void SetSorted(bool enable)
+- void SetAnimationLodBias(float lodBias)
 - void SetEmitterType(EmitterType type)
 - void SetEmitterSize(const Vector3& size)
+- void SetMinDirection(const Vector3& direction)
+- void SetMaxDirection(const Vector3& direction)
+- void SetConstantForce(const Vector3& force)
+- void SetDampingForce(float force)
 - void SetActiveTime(float time)
 - void SetInactiveTime(float time)
-- void SetEmitting(bool enable)
-- void SetUpdateInvisible(bool enable)
-- void SetTimeToLive(float time)
-- void SetMinTimeToLive(float time)
-- void SetMaxTimeToLive(float time)
-- void SetParticleSize(const Vector2& size)
+- void SetMinEmissionRate(float rate)
+- void SetMaxEmissionRate(float rate)
 - void SetMinParticleSize(const Vector2& size)
 - void SetMaxParticleSize(const Vector2& size)
-- void SetMinDirection(const Vector3& direction)
-- void SetMaxDirection(const Vector3& direction)
-- void SetVelocity(float velocity)
+- void SetMinTimeToLive(float time)
+- void SetMaxTimeToLive(float time)
 - void SetMinVelocity(float velocity)
 - void SetMaxVelocity(float velocity)
-- void SetRotation(float rotation)
 - void SetMinRotation(float rotation)
 - void SetMaxRotation(float rotation)
-- void SetRotationSpeed(float speed)
 - void SetMinRotationSpeed(float speed)
 - void SetMaxRotationSpeed(float speed)
-- void SetConstantForce(const Vector3& force)
-- void SetDampingForce(float force)
 - void SetSizeAdd(float sizeAdd)
 - void SetSizeMul(float sizeMul)
-- void SetColor(const Color& color)
-- void SetNumColors(unsigned num)
-- void SetNumTextureFrames(unsigned num)
-- void ResetEmissionTimer()
-- void RemoveAllParticles()
-- void Reset()
+- void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
+- void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
+- Material* GetMaterial() const
 - unsigned GetNumParticles() const
-- bool IsEmitting() const
 - bool GetUpdateInvisible() const
-- float GetMinEmissionRate() const
-- float GetMaxEmissionRate() const
+- bool IsRelative() const
+- bool IsScaled() const
+- bool IsSorted() const
+- float GetAnimationLodBias() const
 - EmitterType GetEmitterType() const
 - const Vector3& GetEmitterSize() const
+- const Vector3& GetMinDirection() const
+- const Vector3& GetMaxDirection() const
+- const Vector3& GetConstantForce() const
+- float GetDampingForce() const
 - float GetActiveTime() const
 - float GetInactiveTime() const
-- float GetMinTimeToLive() const
-- float GetMaxTimeToLive() const
+- float GetMinEmissionRate() const
+- float GetMaxEmissionRate() const
 - const Vector2& GetMinParticleSize() const
 - const Vector2& GetMaxParticleSize() const
-- const Vector3& GetMinDirection() const
-- const Vector3& GetMaxDirection() const
+- float GetMinTimeToLive() const
+- float GetMaxTimeToLive() const
 - float GetMinVelocity() const
 - float GetMaxVelocity() const
 - float GetMinRotation() const
 - float GetMaxRotation() const
 - float GetMinRotationSpeed() const
 - float GetMaxRotationSpeed() const
-- const Vector3& GetConstantForce() const
-- float GetDampingForce() const
 - float GetSizeAdd() const
 - float GetSizeMul() const
-- unsigned GetNumColors() const
-- ColorFrame* GetColor(unsigned index)
+- unsigned GetNumColorFrames() const
+- const ColorFrame* GetColorFrame(unsigned index) const
 - unsigned GetNumTextureFrames() const
-- TextureFrame* GetTextureFrame(unsigned index)
+- const TextureFrame* GetTextureFrame(unsigned index) const
 
 Properties:
 
+- Material* material
 - unsigned numParticles
-- float emissionRate
-- bool emitting
 - bool updateInvisible
-- float minEmissionRate
-- float maxEmissionRate
+- bool relative
+- bool scaled
+- bool sorted
+- float animationLodBias
 - EmitterType emitterType
-- Vector3& emitterSize
+- const Vector3& emitterSize
+- const Vector3& minDirection
+- const Vector3& maxDirection
+- const Vector3& constantForce
+- float dampingForce
 - float activeTime
 - float inactiveTime
-- float timeToLive
+- float minEmissionRate
+- float maxEmissionRate
+- const Vector2& minParticleSize
+- const Vector2& maxParticleSize
 - float minTimeToLive
 - float maxTimeToLive
-- Vector2& particleSize
-- Vector2& minParticleSize
-- Vector2& maxParticleSize
-- Vector3& minDirection
-- Vector3& maxDirection
-- float velocity
 - float minVelocity
 - float maxVelocity
-- float rotation
 - float minRotation
 - float maxRotation
-- float rotationSpeed
 - float minRotationSpeed
 - float maxRotationSpeed
-- Vector3& constantForce
-- float dampingForce
 - float sizeAdd
 - float sizeMul
-- unsigned numColors
+- unsigned numColorFrames
 - unsigned numTextureFrames
 
+### ParticleEffect2D : Resource
+
+### ParticleEmitter : BillboardSet
+
+Methods:
+
+- void SetEffect(ParticleEffect* effect)
+- void SetNumParticles(unsigned num)
+- void SetEmitting(bool enable)
+- void ResetEmissionTimer()
+- void RemoveAllParticles()
+- void Reset()
+- void ApplyEffect()
+- ParticleEffect* GetEffect() const
+- unsigned GetNumParticles() const
+- bool IsEmitting() const
+
+Properties:
+
+- ParticleEffect* effect
+- unsigned numParticles
+- bool emitting
+
 ### ParticleEmitter2D : Drawable2D
 
 Methods:

Docs/ScriptAPI.dox

@@ -1323,45 +1323,14 @@ namespace Urho3D
 
 ### ParticleEmitter
 - %Is %Enabled : bool
-- %Material : ResourceRef
-- %Max %Particles : int
-- %Emission %Rate %Min : float
-- %Emission %Rate %Max : float
-- %Emitter %Type : int
-- %Emitter %Size : Vector3
-- %Active %Time : float
-- %Inactive %Time : float
-- %Is %Emitting : bool
-- %Update %When %Invisible : bool
-- %Relative %Position : bool
-- %Relative %Scale : bool
-- %Sort %By %Distance : bool
+- %Effect : ResourceRef
 - %Face %Camera %Mode : int
-- %Time %To %Live %Min : float
-- %Time %To %Live %Max : float
-- %Particle %Size %Min : Vector2
-- %Particle %Size %Max : Vector2
-- %Direction %Min : Vector3
-- %Direction %Max : Vector3
-- %Velocity %Min : float
-- %Velocity %Max : float
-- %Rotation %Min : float
-- %Rotation %Max : float
-- %Rotation %Speed %Min : float
-- %Rotation %Speed %Max : float
-- %Constant %Force : Vector3
-- %Damping %Force : float
-- %Size %Add : float
-- %Size %Mul : float
-- %Particle %Colors : VariantVector
-- %UV %Animation : VariantVector
 - %Can %Be %Occluded : bool
 - %Cast %Shadows : bool
 - %Draw %Distance : float
 - %Shadow %Distance : float
 - %Animation %LOD %Bias : float
-- %Period %Timer : float
-- %Emission %Timer : float
+- %Is %Emitting : bool
 
 ### ParticleEmitter2D
 - %Particle %Effect : ResourceRef
@@ -7213,6 +7182,64 @@ Properties:
 - int weakRefs // readonly
 
 
+### ParticleEffect
+
+Methods:
+
+- ColorFrame@ GetColorFrame(uint) const
+- TextureFrame@ GetTextureFrame(uint) const
+- bool Load(File@)
+- bool Load(VectorBuffer&)
+- bool Save(File@) const
+- bool Save(VectorBuffer&) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- void SetColorFrame(uint, ColorFrame@) const
+- void SetTextureFrame(uint, TextureFrame@) const
+
+Properties:
+
+- float activeTime
+- float animationLodBias
+- ShortStringHash baseType // readonly
+- String category // readonly
+- Vector3 constantForce
+- float dampingForce
+- Vector3 emitterSize
+- EmitterType emitterType
+- float inactiveTime
+- Material@ material
+- Vector3 maxDirection
+- float maxEmissionRate
+- Vector3 maxParticleSize
+- float maxRotation
+- float maxRotationSpeed
+- float maxTimeToLive
+- float maxVelocity
+- uint memoryUse // readonly
+- Vector3 minDirection
+- float minEmissionRate
+- Vector2 minParticleSize
+- float minRotation
+- float minRotationSpeed
+- float minTimeToLive
+- float minVelocity
+- String name
+- uint numColorFrames // readonly
+- uint numParticles
+- uint numTextureFrames // readonly
+- int refs // readonly
+- bool relative
+- bool scaled
+- float sizeAdd
+- float sizeMul
+- bool sorted
+- ShortStringHash type // readonly
+- String typeName // readonly
+- bool updateInvisible
+- uint useTimer // readonly
+- int weakRefs // readonly
+
+
 ### ParticleEffect2D
 
 Methods:
@@ -7241,6 +7268,8 @@ Properties:
 Methods:
 
 - void ApplyAttributes()
+- void ApplyEffect()
+- void Commit()
 - void DrawDebugGeometry(DebugRenderer@, bool)
 - Variant GetAttribute(const String&) const
 - ValueAnimation@ GetAttributeAnimation(const String&) const
@@ -7250,7 +7279,6 @@ Methods:
 - bool IsInView(Camera@) const
 - bool Load(File@, bool = false)
 - bool Load(VectorBuffer&, bool = false)
-- bool Load(XMLFile@)
 - bool LoadXML(const XMLElement&, bool = false)
 - void MarkNetworkUpdate() const
 - void Remove()
@@ -7261,85 +7289,53 @@ Methods:
 - void ResetToDefault()
 - bool Save(File@) const
 - bool Save(VectorBuffer&) const
-- bool Save(XMLFile@)
 - bool SaveXML(XMLElement&) const
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
 - bool SetAttribute(const String&, const Variant&)
 - void SetAttributeAnimation(const String&, ValueAnimation@, WrapMode = WM_LOOP, float = 1.0f)
 - void SetAttributeAnimationSpeed(const String&, float)
 - void SetAttributeAnimationWrapMode(const String&, WrapMode)
-- void SetColor(const Color&)
 
 Properties:
 
-- float activeTime
 - bool animationEnabled
 - float animationLodBias
 - Variant[] attributeDefaults // readonly
 - AttributeInfo[] attributeInfos // readonly
 - Variant[] attributes
 - ShortStringHash baseType // readonly
+- Billboard@[] billboards // readonly
 - BoundingBox boundingBox // readonly
 - bool castShadows
 - String category // readonly
-- ColorFrame@[] colors // readonly
-- Vector3 constantForce
-- float dampingForce
 - float drawDistance
-- float emissionRate // writeonly
-- Vector3 emitterSize
-- EmitterType emitterType
+- ParticleEffect@ effect
 - bool emitting
 - bool enabled
 - bool enabledEffective // readonly
 - FaceCameraMode faceCameraMode
 - uint id // readonly
 - bool inView // readonly
-- float inactiveTime
 - uint lightMask
 - float lodBias
 - Material@ material
-- Vector3 maxDirection
-- float maxEmissionRate
 - uint maxLights
-- Vector3 maxParticleSize
-- float maxRotation
-- float maxRotationSpeed
-- float maxTimeToLive
-- float maxVelocity
-- Vector3 minDirection
-- float minEmissionRate
-- Vector2 minParticleSize
-- float minRotation
-- float minRotationSpeed
-- float minTimeToLive
-- float minVelocity
 - Node@ node // readonly
 - uint numAttributes // readonly
-- uint numColors
+- uint numBillboards
 - uint numParticles
-- uint numTextureFrames
 - ObjectAnimation@ objectAnimation
 - bool occludee
 - bool occluder
-- Vector2 particleSize // writeonly
 - int refs // readonly
 - bool relative
-- float rotation // writeonly
-- float rotationSpeed // writeonly
 - bool scaled
 - float shadowDistance
 - uint shadowMask
-- float sizeAdd
-- float sizeMul
 - bool sorted
 - bool temporary
-- TextureFrame@[] textureFrames // readonly
-- float timeToLive // writeonly
 - ShortStringHash type // readonly
 - String typeName // readonly
-- bool updateInvisible
-- float velocity // writeonly
 - uint viewMask
 - int weakRefs // readonly
 - BoundingBox worldBoundingBox // readonly