🎮CUserCmd

Describes a user command.

commandNumber

FieldRead only

Type: int

Current command number.

---

GetButton

Method

Returns state of the specified button.

Arguments

1. Button

Name	Type	Description
button	InputBitMask_t	Button.

Returns

Type	Description
bool	Is pressed.

Example

if cmd:GetButton(InputBitMask_t.IN_USE) then
    -- ...
end

---

SetButton

Method

Sets the specified button into the command.

Arguments

1. Button

Name	Type	Description
button	InputBitMask_t	Button.

Example

cmd:SetButton(InputBitMask_t.IN_USE)

---

RemoveButton

Method

Removes the specified button from the command.

Arguments

1. Button

Name	Type	Description
button	InputBitMask_t	Button.

Example

cmd:RemoveButton(InputBitMask_t.IN_ATTACK)

---

GetViewangles

Method

Returns the current viewangles of the command.

Arguments

None.

Returns

Type	Description
Vector	Viewangles.

Example

local ang = cmd:GetViewangles();

---

SetViewangles

Method

Sets the specified angles into the command.

Arguments

1. Angles

Name	Type	Description
angles	Vector	Angles.

Example

cmd:SetViewangles(target_angles)

---

LockAngles

Method

Sets the command viewangles into the games view.

Arguments

None.

Example

cmd:SetViewangles(target_angles)
cmd:LockAngles()

---

GetForwardMove

Method

Returns the forwardmove of the command. (0.0 - 1.0)

Arguments

None.

Returns

Type	Description
float	forwardmove.

Example

local fmove = cmd:GetForwardMove();

---

GetLeftMove

Method

Returns the leftmove of the command. (0.0 - 1.0)

Arguments

None.

Returns

Type	Description
float	leftmove.

Example

local lmove = cmd:GetLeftMove();

---

SetForwardMove

Method

Sets the specified forwardmove into the command. (0.0 - 1.0)

Arguments

Type	Description
float	forwardmove.

Example

cmd:SetForwardMove(1.0);

---

SetLeftMove

Method

Sets the specified leftmove into the command. (0.0 - 1.0)

Arguments

Type	Description
float	leftmove.

Example

cmd:SetLeftMove(1.0);

---

RotateMovement

Method

Rotates the commands movement toward the specified yaw without affecting viewangles.

Arguments

Type	Description
float	yaw.

Example

cmd:SetLeftMove(0.0);
cmd:SetForwardMove(1.0);
cmd:RotateMovement(target_yaw);