Difference between revisions of "IS BFN"

From LFS Manual
Jump to navigationJump to search
(Created page with "== Introduction == The '''B'''utton '''F'''unctio'''N''' packet is used to delete buttons created with IS_BTN, or is sent by LFS when a user clears or requests buttons....")
 
 
Line 1: Line 1:
== Introduction ==
+
{{Infobox InSim packet
 +
| description  = Delete InSim buttons, or receive button requests
 +
| size          = 8
 +
| type_key      = ISP_BFN
 +
| type_value    = 42
 +
| direction    = in-out
 +
| prev          = [[IS_CRS]]
 +
| next          = [[IS_AXI]]
 +
}}
  
 
The '''B'''utton '''F'''unctio'''N''' packet is used to delete buttons created with [[IS_BTN]], or is sent by LFS when a user clears or requests buttons.
 
The '''B'''utton '''F'''unctio'''N''' packet is used to delete buttons created with [[IS_BTN]], or is sent by LFS when a user clears or requests buttons.
 +
 +
== Packet details ==
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 24: Line 34:
 
| byte || Inst || used internally by InSim
 
| byte || Inst || used internally by InSim
 
|}
 
|}
 
== Packet Details ==
 
  
 
=== Size ===
 
=== Size ===
Line 61: Line 69:
  
 
Used internally by InSim.
 
Used internally by InSim.
 +
 +
{{InSim packets}}
  
 
[[Category:InSim packets]]
 
[[Category:InSim packets]]

Latest revision as of 11:30, 14 February 2026

IS_BFN
Delete InSim buttons, or receive button requests
Overview
Size 8
Type ISP_BFN (42)
Usage both ways
Previous packet
IS_CRS
Next packet
IS_AXI

The Button FunctioN packet is used to delete buttons created with IS_BTN, or is sent by LFS when a user clears or requests buttons.

Packet details

IS_BFN packet properties
Type Name Description
byte Size 8
byte Type ISP_BFN
byte ReqI 0
byte SubT subtype, from BFN_ enumeration (see below)
byte UCID connection to send to or received from (0 = local / 255 = all)
byte ClickID if SubT is BFN_DEL_BTN: ID of single button to delete or first button in range
byte ClickMax if SubT is BFN_DEL_BTN: ID of last button in range (if greater than ClickID)
byte Inst used internally by InSim

Size

The packet size is always 8 bytes.

Type

The packet type from the ISP_ enumeration, always ISP_BFN.

ReqI

ReqI is always equal to zero.

SubT

The sub-type, from the BFN_ enumeration:

  • BFN_DEL_BTN: delete a button or a range of buttons
  • BFN_CLEAR: clear all buttons made by this InSim instance
  • BFN_USER_CLEAR: user cleared this instance's buttons
  • BFN_REQUEST: user pressed Shift+B or Shift+I to request buttons

UCID

The connection to send to, or received from. 0 means local, 255 means everyone.

ClickID

If SubT is BFN_DEL_BTN, this is the ID of the button to delete, or the first in a range to delete.

ClickMax

If SubT is BFN_DEL_BTN, this is the ID of the last button in the range to delete. It must be greater than ClickID to have an effect.

Inst

Used internally by InSim.


Initialisation IS_ISI
Version Information IS_VER
General Purpose IS_TINY · IS_SMALL · IS_TTC
State Reporting and Requests IS_STA · IS_SFP · IS_ISM
Text Messages and Key Presses IS_SCH · IS_MSO · IS_III · IS_MST · IS_MTC · IS_MSX · IS_MSL
Voting IS_VTN
Race Tracking IS_RST · IS_REO
Autocross IS_AXI · IS_AXO · IS_UCO · IS_OCO · IS_AXM
Connection Tracking IS_NCN · IS_CNL · IS_CPR · IS_ACR · IS_NCI · IS_SLC · IS_CIM
Car Tracking IS_NPL · IS_PLP · IS_PLL · IS_LAP · IS_SPX · IS_PIT · IS_PSF · IS_PLA · IS_PEN · IS_TOC · IS_FLG · IS_PFL · IS_FIN · IS_RES · IS_NLP · IS_MCI · IS_CRS · IS_CON · IS_OBH · IS_HLV · IS_CSC
Camera Control IS_SCC · IS_CPP
Replay Control IS_RIP
Screenshots IS_SSH
InSim Buttons IS_BFN · IS_BTN · IS_BTC · IS_BTT
AI Control IS_AIC · IS_AII
Other packets IS_MOD · IS_CCH · IS_PLC · IS_HCP · IS_JRR · IS_MAL · IS_PLH · IS_IPB