Difference between revisions of "IS SMALL"

From LFS Manual
Jump to navigationJump to search
m
Line 1: Line 1:
== Introduction ==
+
{{Infobox InSim packet
 +
| description  = General purpose 8-byte packet with a 4-byte value
 +
| size          = 8
 +
| type_key      = ISP_SMALL
 +
| type_value    = 4
 +
| direction    = in-out
 +
| category      = General purpose
 +
| prev          = [[IS_TINY]]
 +
| next          = [[IS_TTC]]
 +
}}
  
The IS_SMALL packet is a general purpose packet comprised of 8 bytes. The packet is designed to prevent repeating a common structure which would be the same for many packets. Unlike the [[IS_TINY]] the IS_SMALL also contains the UVal, a 4 byte unsigned integer.
+
The '''IS_SMALL''' packet is a general purpose packet comprised of 8 bytes. The packet is designed to prevent repeating a common structure which would be the same for many packets. Unlike the [[IS_TINY]] the IS_SMALL also contains the UVal, a 4 byte unsigned integer.
 +
 
 +
== Packet details ==
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 28: Line 39:
 
| value (e.g. for SMALL_SSP this would be the OutSim packet rate)
 
| value (e.g. for SMALL_SSP this would be the OutSim packet rate)
 
|}
 
|}
 
== Packet Details ==
 
  
 
=== Size ===
 
=== Size ===
Line 65: Line 74:
  
 
A general purpose 4-byte unsigned integer, the meaning of which varies depending on [[#SubT|SubT]].
 
A general purpose 4-byte unsigned integer, the meaning of which varies depending on [[#SubT|SubT]].
 +
 +
{{InSim packets}}
  
 
[[Category:InSim packets]]
 
[[Category:InSim packets]]

Revision as of 19:09, 13 February 2026

IS_SMALL
General purpose 8-byte packet with a 4-byte value
Overview
Size 8
Type ISP_SMALL (4)
Usage both ways
Previous packet
IS_TINY
Next packet
IS_TTC

The IS_SMALL packet is a general purpose packet comprised of 8 bytes. The packet is designed to prevent repeating a common structure which would be the same for many packets. Unlike the IS_TINY the IS_SMALL also contains the UVal, a 4 byte unsigned integer.

Packet details

IS_SMALL packet properties
Type Name Description
byte Size 8
byte Type ISP_SMALL
byte ReqI 0 unless it is an info request or a reply to an info request
byte SubT subtype, from SMALL_ enumeration (e.g. SMALL_SSP)
unsigned UVal value (e.g. for SMALL_SSP this would be the OutSim packet rate)

Size

The size of the packet, always 8 bytes.

Type

The packet type from the ISP_ enumeration, always ISP_SMALL.

ReqI

ReqI must be set to non-zero when sending a request for information to LFS, and in turn the replying packet will contain the same value set in its ReqI. For packets sent by LFS without a request, ReqI is zero.

SubT

The packet's sub-type, which is a value from the SMALL_ enum.

  • SMALL_NONE: Not used
  • SMALL_SSP: Request to start sending OutSim packets at the specified interval
  • SMALL_SSG: Request to start sending OutGauge packets at the specified interval
  • SMALL_VTA: Send to set the current vote action, from the VOTE_ enumeration
  • SMALL_TMS: Send in single-player mode to stop time, 1 means to stop and 0 to carry on. This freezes the game but is not the same as pausing, as the game must be unfrozen before any further actions can be undertaken
  • SMALL_STP: Send when frozen to update the game time by the specified hundredths
  • SMALL_RTP: Sent in response to an IS_TINY with a SubT of TINY_GTH. Contains the time in ms.
  • SMALL_NLI: Send to set the IS_NLP/IS_MCI interval
  • SMALL_ALC: Send to set allowed cars; sent in reply to IS_TINY TINY_ALC.
  • SMALL_LCS: Send to set the local car's switches; sent in reply to IS_TINY TINY_LCS.
  • SMALL_LCL: Send to set the local car's lights; sent in reply to IS_TINY TINY_LCL.
  • SMALL_AII: Send to request a local AI car's info.

Note: SMALL_TMS and SMALL_STP are currently not available in LFS 0.8B/InSim 10.

UVal

A general purpose 4-byte unsigned integer, the meaning of which varies depending on SubT.


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