@tlua/gmod 1.0.1

package/cluaparticle.d.tlua

@@ -0,0 +1,426 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * List of all possible functions available for Lua particles. This is the object returned by the [CLuaEmitter:Add](https://wiki.facepunch.com/gmod/CLuaEmitter:Add) function.
+ * @source https://wiki.facepunch.com/gmod/CLuaParticle
+ */
+interface CLuaParticle {}
+
+interface CLuaParticle {
+    /**
+     * Returns the air resistance of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetAirResistance
+     */
+    GetAirResistance(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the angular velocity of the particle
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetAngleVelocity
+     */
+    GetAngleVelocity(self: CLuaParticle): Angle;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the current orientation of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetAngles
+     */
+    GetAngles(self: CLuaParticle): Angle;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the 'bounciness' of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetBounce
+     */
+    GetBounce(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the color of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetColor
+     */
+    GetColor(self: CLuaParticle): (number, number, number);
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the amount of time in seconds after which the particle will be destroyed.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetDieTime
+     */
+    GetDieTime(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the alpha value that the particle will reach on its death.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetEndAlpha
+     */
+    GetEndAlpha(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the length that the particle will reach on its death.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetEndLength
+     */
+    GetEndLength(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the size that the particle will reach on its death.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetEndSize
+     */
+    GetEndSize(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the gravity of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetGravity
+     */
+    GetGravity(self: CLuaParticle): Vector;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the 'life time' of the particle, how long the particle existed since its creation.
+     *
+     * This value will always be between 0 and [CLuaParticle:GetDieTime](https://wiki.facepunch.com/gmod/CLuaParticle:GetDieTime).
+     *
+     *
+     * It changes automatically as time goes.
+     *
+     * It can be manipulated using [CLuaParticle:SetLifeTime](https://wiki.facepunch.com/gmod/CLuaParticle:SetLifeTime).
+     *
+     *
+     * If the life time of the particle will be more than [CLuaParticle:GetDieTime](https://wiki.facepunch.com/gmod/CLuaParticle:GetDieTime), it will be removed.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetLifeTime
+     */
+    GetLifeTime(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the current material of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetMaterial
+     */
+    GetMaterial(self: CLuaParticle): IMaterial;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the absolute position of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetPos
+     */
+    GetPos(self: CLuaParticle): Vector;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the current rotation of the particle in radians, this should only be used for 2D particles.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetRoll
+     */
+    GetRoll(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the current rotation speed of the particle in radians, this should only be used for 2D particles.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetRollDelta
+     */
+    GetRollDelta(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the alpha value which the particle has when it's created.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetStartAlpha
+     */
+    GetStartAlpha(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the length which the particle has when it's created.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetStartLength
+     */
+    GetStartLength(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the size which the particle has when it's created.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetStartSize
+     */
+    GetStartSize(self: CLuaParticle): number;
+}
+
+interface CLuaParticle {
+    /**
+     * Returns the current velocity of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:GetVelocity
+     */
+    GetVelocity(self: CLuaParticle): Vector;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the air resistance of the the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetAirResistance
+     */
+    SetAirResistance(self: CLuaParticle, airResistance: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the angular velocity of the the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetAngleVelocity
+     */
+    SetAngleVelocity(self: CLuaParticle, angVel: Angle): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the angles of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetAngles
+     */
+    SetAngles(self: CLuaParticle, ang: Angle): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the 'bounciness' of the the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetBounce
+     */
+    SetBounce(self: CLuaParticle, bounce: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the whether the particle should collide with the world or not.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetCollide
+     */
+    SetCollide(self: CLuaParticle, shouldCollide: boolean): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the function that gets called whenever the particle collides with the world.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetCollideCallback
+     */
+    SetCollideCallback(self: CLuaParticle, collideFunc: (particle: CLuaParticle, hitPos: Vector, hitNormal: Vector) => void): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the color of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetColor
+     */
+    SetColor(self: CLuaParticle, r: number, g: number, b: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the time where the particle will be removed.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetDieTime
+     */
+    SetDieTime(self: CLuaParticle, dieTime: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the alpha value of the particle that it will reach when it dies.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetEndAlpha
+     */
+    SetEndAlpha(self: CLuaParticle, endAlpha: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the length of the particle that it will reach when it dies.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetEndLength
+     */
+    SetEndLength(self: CLuaParticle, endLength: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the size of the particle that it will reach when it dies.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetEndSize
+     */
+    SetEndSize(self: CLuaParticle, endSize: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the directional gravity aka. acceleration of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetGravity
+     */
+    SetGravity(self: CLuaParticle, gravity: Vector): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the 'life time' of the particle, how long the particle existed since its creation.
+     *
+     * This value should always be between 0 and [CLuaParticle:GetDieTime](https://wiki.facepunch.com/gmod/CLuaParticle:GetDieTime).
+     *
+     *
+     * It changes automatically as time goes.
+     *
+     *
+     * If the life time of the particle will be more than [CLuaParticle:GetDieTime](https://wiki.facepunch.com/gmod/CLuaParticle:GetDieTime), it will be removed.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetLifeTime
+     */
+    SetLifeTime(self: CLuaParticle, lifeTime: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets whether the particle should be affected by lighting.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetLighting
+     */
+    SetLighting(self: CLuaParticle, useLighting: boolean): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the material of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetMaterial
+     */
+    SetMaterial(self: CLuaParticle, mat: IMaterial): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets when the particles think function should be called next, this uses the synchronized server time returned by [Global.CurTime](https://wiki.facepunch.com/gmod/Global.CurTime).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetNextThink
+     */
+    SetNextThink(self: CLuaParticle, nextThink: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the absolute position of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetPos
+     */
+    SetPos(self: CLuaParticle, pos: Vector): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the roll of the particle in radians. This should only be used for 2D particles.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetRoll
+     */
+    SetRoll(self: CLuaParticle, roll: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the rotation speed of the particle in radians. This should only be used for 2D particles.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetRollDelta
+     */
+    SetRollDelta(self: CLuaParticle, rollDelta: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the initial alpha value of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetStartAlpha
+     */
+    SetStartAlpha(self: CLuaParticle, startAlpha: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the initial length value of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetStartLength
+     */
+    SetStartLength(self: CLuaParticle, startLength: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the initial size value of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetStartSize
+     */
+    SetStartSize(self: CLuaParticle, startSize: number): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the think function of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetThinkFunction
+     */
+    SetThinkFunction(self: CLuaParticle, thinkFunc: (particle: CLuaParticle) => void): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Sets the velocity of the particle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetVelocity
+     */
+    SetVelocity(self: CLuaParticle, vel: Vector): void;
+}
+
+interface CLuaParticle {
+    /**
+     * Automatically scales the length of the particle based on the particle speed, multiplied with [CLuaParticle:SetStartLength](https://wiki.facepunch.com/gmod/CLuaParticle:SetStartLength) and [CLuaParticle:SetEndLength](https://wiki.facepunch.com/gmod/CLuaParticle:SetEndLength). Width remains the same as [CLuaParticle:SetStartSize](https://wiki.facepunch.com/gmod/CLuaParticle:SetStartSize) and [CLuaParticle:SetEndSize](https://wiki.facepunch.com/gmod/CLuaParticle:SetEndSize).
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaParticle:SetVelocityScale
+     */
+    SetVelocityScale(self: CLuaParticle, doScale?: boolean): void;
+}
+