IS BFN

Introduction

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.

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

Packet Details

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.