Difference between revisions of "IS SFP"

From LFS Manual
Jump to navigationJump to search
m
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
The IS_SFP or State Flags Pack can be used to set various state options in game. Any states not included in this packet must be set by sending either a [[IS_SCH]] or [[IS_MST]] packet.
+
The '''S'''tate '''F'''lags '''P'''ack can be used to set some state options in game. Only a select few states can be set using this packet, other states must be set by sending either an [[IS_SCH]] or [[IS_MST]] packet.
  
<big><pre>struct IS_SFP // State Flags Pack
+
{| class="wikitable"
{
+
|+ IS_SFP packet properties
byte Size; // 8
+
|-
byte Type; // ISP_SFP
+
! Type !! Name !! Description
byte ReqI; // 0
+
|-
byte Zero;
+
| byte
 
+
| Size
word Flag; // the state to set
+
| 8
byte OffOn; // 0 = off / 1 = on
+
|-
byte Sp3; // spare
+
| byte
};</pre></big>
+
| Type
 +
| ISP_SFP
 +
|-
 +
| byte
 +
| ReqI
 +
| 0
 +
|-
 +
| byte
 +
| Zero
 +
|
 +
|-
 +
| word
 +
| Flag
 +
| the state to set
 +
|-
 +
| byte
 +
| OffOn
 +
| 0 = off / 1 = on
 +
|-
 +
| byte
 +
| Sp3
 +
| spare
 +
|}
  
 
== Packet Detail ==
 
== Packet Detail ==
Line 23: Line 45:
 
=== Type ===
 
=== Type ===
  
The packet type from the ISP_ enumeration, always ISP_SFP.
+
The packet type from the [[InSim_enumerations#ISP|ISP_]] enumeration, always ISP_SFP.
  
 
=== ReqI ===
 
=== ReqI ===
Line 31: Line 53:
 
=== Flags ===
 
=== Flags ===
  
The state to set, from the ISS_ bit flags. The states you are able to set are as follows:
+
The state to set, from the ISS_ bit flags. The states you are able to set are the following:
  
* ISS_SHIFTU_FOLLOW: Following car
 
 
* ISS_SHIFTU_NO_OPT: SHIFT+U buttons hidden
 
* ISS_SHIFTU_NO_OPT: SHIFT+U buttons hidden
 
* ISS_SHOW_2D: Showing 2d display
 
* ISS_SHOW_2D: Showing 2d display
Line 39: Line 60:
 
* ISS_SOUND_MUTE: Sound is switched off
 
* ISS_SOUND_MUTE: Sound is switched off
  
=== OnOff ===
+
=== OffOn ===
  
 
Set to 1 to turn the state on, or set to 0 to turn the state off.
 
Set to 1 to turn the state on, or set to 0 to turn the state off.
  
 
[[Category:InSim packets]]
 
[[Category:InSim packets]]

Revision as of 20:46, 9 February 2026

Introduction

The State Flags Pack can be used to set some state options in game. Only a select few states can be set using this packet, other states must be set by sending either an IS_SCH or IS_MST packet.

IS_SFP packet properties
Type Name Description
byte Size 8
byte Type ISP_SFP
byte ReqI 0
byte Zero
word Flag the state to set
byte OffOn 0 = off / 1 = on
byte Sp3 spare

Packet Detail

Size

The size of the packet, always 8 bytes.

Type

The packet type from the ISP_ enumeration, always ISP_SFP.

ReqI

Not used

Flags

The state to set, from the ISS_ bit flags. The states you are able to set are the following:

  • ISS_SHIFTU_NO_OPT: SHIFT+U buttons hidden
  • ISS_SHOW_2D: Showing 2d display
  • ISS_MPSPEEDUP: Multiplayer speedup option
  • ISS_SOUND_MUTE: Sound is switched off

OffOn

Set to 1 to turn the state on, or set to 0 to turn the state off.