Skip to content
Josh Goebel edited this page Jan 27, 2021 · 27 revisions

btn

btn [id] -> pressed

Parameters:

  • id : id (0..31) of the key we want to interrogate (see the key map for reference)

Output:

  • pressed : button is pressed (true/false)

Description:

This function allows you to read the status of one of the buttons attached to TIC. The function returns true if the key with the supplied id is currently in the pressed state. It remains true for as long as the key is held down. If you want to test if a key was just pressed, use btnp instead,

Old example courtesy of Rain_Effect:

Example

--Key Test Project
--By Rain_Effect
local x=70
local y=25
local btnLabel={"Up","Down","Left","Right","Btn A","Btn B"}
function TIC()
  cls(0)

  print("Key Test Project",x,y)
  print("Btn",x,y+15,2)
  print("1P",x+50,y+15,2)
  print("2P",x+80,y+15,2)

  for i=1,6 do
    print(btnLabel[i],x,y+(i+1)*10+5)

    -- gamepad 1
    if btn(i-1) then
      print("On",x+50,y+(i+1)*10+5,11)
    else
      print("Off",x+47,y+(i+1)*10+5,6)
    end

    -- gamepad 2
    if btn(i+7) then
      print("On",x+80,y+(i+1)*10+5,11)
    else
      print("Off",x+77,y+(i+1)*10+5,6)
    end
  end
end

The gamepad states (On/Off) are updated each frame as you press and release the buttons.**

Clone this wiki locally