@tlua/gmod 1.0.1

package/cmovedata.d.tlua

@@ -0,0 +1,476 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A class used to store the inputs from [CUserCmd](https://wiki.facepunch.com/gmod/CUserCmd) and other information related to the current movement simulation, such as velocity, position and so on.
+ *
+ * This can only be accessed during [GM:SetupMove](https://wiki.facepunch.com/gmod/GM:SetupMove) , [GM:Move](https://wiki.facepunch.com/gmod/GM:Move) , [GM:PlayerTick](https://wiki.facepunch.com/gmod/GM:PlayerTick) and [GM:FinishMove](https://wiki.facepunch.com/gmod/GM:FinishMove).
+ * @source https://wiki.facepunch.com/gmod/CMoveData
+ */
+interface CMoveData {}
+
+interface CMoveData {
+    /**
+     * Adds keys to the move data, as if player pressed them.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:AddKey
+     */
+    AddKey(self: CMoveData, keys: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Gets the aim angle. Seems to be same as [CMoveData:GetAngles](https://wiki.facepunch.com/gmod/CMoveData:GetAngles).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetAbsMoveAngles
+     */
+    GetAbsMoveAngles(self: CMoveData): Angle;
+}
+
+interface CMoveData {
+    /**
+     * Gets the aim angle. On client is the same as [Entity:GetAngles](https://wiki.facepunch.com/gmod/Entity:GetAngles).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetAngles
+     */
+    GetAngles(self: CMoveData): Angle;
+}
+
+interface CMoveData {
+    /**
+     * Gets which buttons are down
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetButtons
+     */
+    GetButtons(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the center of the player movement constraint. See [CMoveData:SetConstraintCenter](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintCenter).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetConstraintCenter
+     */
+    GetConstraintCenter(self: CMoveData): Vector;
+}
+
+interface CMoveData {
+    /**
+     * Returns the radius that constrains the players movement. See [CMoveData:SetConstraintRadius](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintRadius).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetConstraintRadius
+     */
+    GetConstraintRadius(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the player movement constraint speed scale. See [CMoveData:SetConstraintSpeedScale](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintSpeedScale).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetConstraintSpeedScale
+     */
+    GetConstraintSpeedScale(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the width (distance from the edge of the radius, inward) where the actual movement constraint functions.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetConstraintWidth
+     */
+    GetConstraintWidth(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns an internal player movement variable `m_outWishVel`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetFinalIdealVelocity
+     */
+    GetFinalIdealVelocity(self: CMoveData): Vector;
+}
+
+interface CMoveData {
+    /**
+     * Returns an internal player movement variable `m_outJumpVel`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetFinalJumpVelocity
+     */
+    GetFinalJumpVelocity(self: CMoveData): Vector;
+}
+
+interface CMoveData {
+    /**
+     * Returns an internal player movement variable `m_outStepHeight`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetFinalStepHeight
+     */
+    GetFinalStepHeight(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the players forward speed.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetForwardSpeed
+     */
+    GetForwardSpeed(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Gets the number passed to "impulse" console command
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetImpulseCommand
+     */
+    GetImpulseCommand(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the maximum client speed of the player
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetMaxClientSpeed
+     */
+    GetMaxClientSpeed(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the maximum speed of the player.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetMaxSpeed
+     */
+    GetMaxSpeed(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the angle the player is moving at. For more info, see [CMoveData:SetMoveAngles](https://wiki.facepunch.com/gmod/CMoveData:SetMoveAngles).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetMoveAngles
+     */
+    GetMoveAngles(self: CMoveData): Angle;
+}
+
+interface CMoveData {
+    /**
+     * Gets the aim angle. Only works clientside, server returns same as [CMoveData:GetAngles](https://wiki.facepunch.com/gmod/CMoveData:GetAngles).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetOldAngles
+     */
+    GetOldAngles(self: CMoveData): Angle;
+}
+
+interface CMoveData {
+    /**
+     * Get which buttons were down last frame
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetOldButtons
+     */
+    GetOldButtons(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Gets the player's position.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetOrigin
+     */
+    GetOrigin(self: CMoveData): Vector;
+}
+
+interface CMoveData {
+    /**
+     * Returns the strafe speed of the player.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetSideSpeed
+     */
+    GetSideSpeed(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Returns the vertical speed of the player. ( Z axis of [CMoveData:GetVelocity](https://wiki.facepunch.com/gmod/CMoveData:GetVelocity) )
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetUpSpeed
+     */
+    GetUpSpeed(self: CMoveData): number;
+}
+
+interface CMoveData {
+    /**
+     * Gets the players velocity.
+     *
+     * This will return Vector(0,0,0) sometimes when walking on props.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:GetVelocity
+     */
+    GetVelocity(self: CMoveData): Vector;
+}
+
+interface CMoveData {
+    /**
+     * Returns whether the key is down or not
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:KeyDown
+     */
+    KeyDown(self: CMoveData, key: number): boolean;
+}
+
+interface CMoveData {
+    /**
+     * Returns whether the key was pressed. If you want to check if the key is held down, try [CMoveData:KeyDown](https://wiki.facepunch.com/gmod/CMoveData:KeyDown)
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:KeyPressed
+     */
+    KeyPressed(self: CMoveData, key: number): boolean;
+}
+
+interface CMoveData {
+    /**
+     * Returns whether the key was released
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:KeyReleased
+     */
+    KeyReleased(self: CMoveData, key: number): boolean;
+}
+
+interface CMoveData {
+    /**
+     * Returns whether the key was down or not.
+     *
+     *
+     *
+     *
+     * Unlike [CMoveData:KeyDown](https://wiki.facepunch.com/gmod/CMoveData:KeyDown), it will return false if [CMoveData:KeyPressed](https://wiki.facepunch.com/gmod/CMoveData:KeyPressed) is true and it will return true if [CMoveData:KeyReleased](https://wiki.facepunch.com/gmod/CMoveData:KeyReleased) is true.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:KeyWasDown
+     */
+    KeyWasDown(self: CMoveData, key: number): boolean;
+}
+
+interface CMoveData {
+    /**
+     * Sets absolute move angles.( ? ) Doesn't seem to do anything.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetAbsMoveAngles
+     */
+    SetAbsMoveAngles(self: CMoveData, ang: Angle): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets angles.
+     *
+     * This function does nothing.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetAngles
+     */
+    SetAngles(self: CMoveData, ang: Angle): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the pressed buttons on the move data
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetButtons
+     */
+    SetButtons(self: CMoveData, buttons: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the center of the player movement constraint. See [CMoveData:SetConstraintRadius](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintRadius).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetConstraintCenter
+     */
+    SetConstraintCenter(self: CMoveData, pos: Vector): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the radius that constrains the players movement.
+     *
+     * Works with conjunction of:
+     * * [CMoveData:SetConstraintWidth](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintWidth)
+     * * [CMoveData:SetConstraintSpeedScale](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintSpeedScale)
+     * * [CMoveData:SetConstraintCenter](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintCenter)
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetConstraintRadius
+     */
+    SetConstraintRadius(self: CMoveData, radius: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the player movement constraint speed scale. This will be applied to the player within the [constraint radius](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintRadius) when approaching its edge.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetConstraintSpeedScale
+     */
+    SetConstraintSpeedScale(self: CMoveData, arg0: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets  the width (distance from the edge of the [radius](https://wiki.facepunch.com/gmod/CMoveData:SetConstraintRadius), inward) where the actual movement constraint functions.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetConstraintWidth
+     */
+    SetConstraintWidth(self: CMoveData, arg0: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets an internal player movement variable `m_outWishVel`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetFinalIdealVelocity
+     */
+    SetFinalIdealVelocity(self: CMoveData, idealVel: Vector): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets an internal player movement variable `m_outJumpVel`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetFinalJumpVelocity
+     */
+    SetFinalJumpVelocity(self: CMoveData, jumpVel: Vector): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets an internal player movement variable `m_outStepHeight`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetFinalStepHeight
+     */
+    SetFinalStepHeight(self: CMoveData, stepHeight: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets players forward speed.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetForwardSpeed
+     */
+    SetForwardSpeed(self: CMoveData, speed: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the impulse command. This isn't actually utilised in the engine anywhere.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetImpulseCommand
+     */
+    SetImpulseCommand(self: CMoveData, impulse: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the maximum player speed. Player won't be able to run or sprint faster then this value.
+     *
+     *
+     * This also automatically sets [CMoveData:SetMaxSpeed](https://wiki.facepunch.com/gmod/CMoveData:SetMaxSpeed) when used in the [GM:SetupMove](https://wiki.facepunch.com/gmod/GM:SetupMove) hook. You must set it manually in the [GM:Move](https://wiki.facepunch.com/gmod/GM:Move) hook.
+     *
+     *
+     * This must be called on both client and server to avoid prediction errors.
+     *
+     *
+     * This will **not** reduce speed in air.
+     * **NOTE**: Setting this to 0 will not make the player stationary. It won't do anything.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetMaxClientSpeed
+     */
+    SetMaxClientSpeed(self: CMoveData, maxSpeed: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the maximum speed of the player. This must match with [CMoveData:SetMaxClientSpeed](https://wiki.facepunch.com/gmod/CMoveData:SetMaxClientSpeed) both, on server and client.
+     *
+     *
+     * Doesn't seem to be doing anything on it's own, use [CMoveData:SetMaxClientSpeed](https://wiki.facepunch.com/gmod/CMoveData:SetMaxClientSpeed) instead.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetMaxSpeed
+     */
+    SetMaxSpeed(self: CMoveData, maxSpeed: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the serverside move angles, making the movement keys act as if player was facing that direction.
+     *
+     * This function is predicted, and should be called shared with matching data on client and server.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetMoveAngles
+     */
+    SetMoveAngles(self: CMoveData, dir: Angle): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets old aim angles. ( ? ) Doesn't seem to be doing anything.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetOldAngles
+     */
+    SetOldAngles(self: CMoveData, aimAng: Angle): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the 'old' pressed buttons on the move data. These buttons are used to work out which buttons have been released, which have just been pressed and which are being held down.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetOldButtons
+     */
+    SetOldButtons(self: CMoveData, buttons: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the players position.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetOrigin
+     */
+    SetOrigin(self: CMoveData, pos: Vector): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets players strafe speed.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetSideSpeed
+     */
+    SetSideSpeed(self: CMoveData, speed: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets vertical speed of the player. ( Z axis of [CMoveData:SetVelocity](https://wiki.facepunch.com/gmod/CMoveData:SetVelocity) )
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetUpSpeed
+     */
+    SetUpSpeed(self: CMoveData, speed: number): void;
+}
+
+interface CMoveData {
+    /**
+     * Sets the player's velocity
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/CMoveData:SetVelocity
+     */
+    SetVelocity(self: CMoveData, velocity: Vector): void;
+}
+