cmd

Modify the current usercmd from createmove.

Module

cmd.current(): cmd | nil


cmd.current(): cmd | nil

Returns the active cmd, or nil outside of createmove.

cmd.buttons


cmd.buttons: { attack, jump, duck, forward, back, use, turnleft, turnright, moveleft, moveright, attack2, reload, sprint, speed, score, scope, zoom, lookatweapon }

Button bit flags used by has_button, set_button, and remove_button.
speed is an alias of sprint. zoom is an alias of scope.

local B = secret.cmd.buttons

Usercmd

The cmd object is only valid for the duration of the callback.

cmd:valid(): boolean


cmd:valid(): boolean

Returns if the cmd is still valid.

cmd:command_number(): number | nil


cmd:command_number(): number | nil

Returns the command sequence number.

Buttons

cmd:get_buttons(): number | nil


cmd:get_buttons(): number | nil

Returns the button mask.

cmd:set_buttons(mask: number)


cmd:set_buttons(mask: number)

Replaces the full button mask.

cmd:has_button(bit: number): boolean


cmd:has_button(bit: number): boolean

Returns if the given button is held.

cmd:set_button(bit: number, down?: boolean)


cmd:set_button(bit: number, down?: boolean)

Sets a button on or off. down defaults to true.

cmd:remove_button(bit: number)


cmd:remove_button(bit: number)

Releases a button.

Angles

cmd:get_view_angles(): number, number, number


cmd:get_view_angles(): number, number, number

Returns pitch, yaw, roll on the cmd.

cmd:set_view_angles(pitch: number, yaw: number, roll: number)


cmd:set_view_angles(pitch: number, yaw: number, roll: number)

Sets pitch, yaw, roll on the cmd (including subtick history).

cmd:lock_angles()


cmd:lock_angles()

Pushes the cmd viewangles into the game view (silent-aim style lock).

cmd:set_view_angles(p, y, r)
cmd:lock_angles()

Movement

cmd:get_move(): number, number, number


cmd:get_move(): number, number, number

Returns forward, side (left), and up move.

cmd:set_move(forward: number, side: number, up: number)


cmd:set_move(forward: number, side: number, up: number)

Sets forward, side, and up move.

cmd:get_forward_move() / set_forward_move(v)


cmd:get_forward_move(): number | nil
cmd:set_forward_move(value: number)

cmd:get_left_move() / set_left_move(v)


cmd:get_left_move(): number | nil
cmd:set_left_move(value: number)

cmd:get_up_move() / set_up_move(v)


cmd:get_up_move(): number | nil
cmd:set_up_move(value: number)

cmd:rotate_movement(yaw: number)


cmd:rotate_movement(yaw: number)

Rotates forward/side move toward yaw without changing viewangles.

cmd:set_forward_move(1)
cmd:set_left_move(0)
cmd:rotate_movement(target_yaw)

Impulse / mouse

cmd:get_impulse() / set_impulse(v)


cmd:get_impulse(): number | nil
cmd:set_impulse(value: number)

cmd:get_mouse_delta() / set_mouse_delta(dx, dy)


cmd:get_mouse_delta(): number, number
cmd:set_mouse_delta(dx: number, dy: number)

secret.listener.add("createmove", "example", function(cmd)
    if not cmd:valid() then return end
    if cmd:has_button(secret.cmd.buttons.jump) then
        cmd:remove_button(secret.cmd.buttons.jump)
    end
end)