Vehicle / Pump / Equipment Documentation

Sombre vehicles are not modding kits. They are designed to be complete, finsihed vehicles. While it is possible to place equipment, pumps, and other items into non-Sombre vehicles, do not expect it to work flawlessly.

Object Names / Descriptions

The name and description of various parts of the vehicle will change it's behaviour.

Do not name objects any of the following:

Strobes

You can change the flash pattern of any strobe by clicking on it.

Making your own strobes

You can use your own mesh strobes and don't need to script them! Make sure that your object is called one of the following Strobe, Strobe Alternate. Then, in the description of your strobe put the following:

[Flash Face]#[Colour Face]#[Flash pattern]
Example:
1#0#2

Driving Position

The driving position can be adjusted in two ways.
You must use [ After Edit ] from the cab menu for changes to take place.

Seats

If you want to add your own seats, you can! Make sure your seat object is named Passenger, and put the following information in the description:

[Sit Position]#[Sit Rotation]#[Animation]#[Door to Open]
Example:
<0,0,0.1>#<-0.70711,0.00021,-0.70711,-0.00021>#none#none If you alter the seating position or rotation, make sure you use [ After Edit ] from the cab menu.

Shutter / Locker / Roller Door

To make your own shutter, make sure that the object is called Shutter, and the description contains the following:

[Axis to offset]#[Face to hide / show]#[Name]
Example:
<1,0,-1>#0#Left1

Doors

If you would like to make your own door, make sure that the hinge point is the centre of the object. Then make sure that the word Door is anywhere in the object name, and the description contains the following:

[Open / Closed]#[Amount to rotate]#[Axis to rotate on]#[Window Offset]#[Window Face]
Example:
0#-70#<0,0,1>#0.0#-1

Link Messages

All of the link messages sent by Sombre scripts use the key field to define the function. You can enable "Debug Mode" from the vehicle menu if you want to see which messages are sent in-world.

The sendable tag indicates that you can both send and receive the message. Any message without this tag should be treated as Read-Only.

Example modification script: 
link_message(integer _sender, integer _num, string _msg, key _id) {
	// Headlights have been turned on or off
	if( _id == "#headlights" ) {
		llSetLinkPrimitiveParamsFast(LINK_THIS, [
			PRIM_FULLBRIGHT, 0, _num
		]);
	}
}
key #numberplate_random sendable

Sent to randomize the numberplate. Random plate will be based on guidelines for current country.

key #numberplate_set sendable

Sent to set a custom number plate. Should be 6-7 characters depending on style in use. Strings longer than 7 characters will be truncated.

  • message Desired number plate
key #numberplate_style sendable

Sent to set the style for the number plates. Available codes are: UK, UKEU, HK, IE, DE, NL, AUSVIC, AUSSA

  • message Number plate style code
key #numberplate_colour sendable

Sets the colour of the number plate font.

  • message (vector)LSL Colour
key #damage

Sent after #get_damage has been sent.

  • message (float) Damage - [100.0 = Full repair]
key #oil

Sent after #get_oil has been sent.

  • message (float) Oil level - [100.0 = Full]
key #def

Sent after #get_def has been sent.

  • message (float) DEF level - [100.0 = Full]
key #coolant

Sent after #get_coolant has been sent.

  • message (float) Coolant level - [100.0 = Full]
key #fuel

Sent after #get_fuel has been sent.

  • message (float) Fuel level - [100.0 = Full]
key #error

An error has occured. Script based error, such as an important piece missing.

  • message Error information
key #warning

Vehicle based warning, such as trying to start the engine in the wrong gear.

  • message Warning information
key #driver_in

Driver has sat down.

  • message (key)Driver UUID
key #driver_out

Driver has stood up.

  • message (key)Driver UUID
key #ignition

Ignition has been switched on or off.

  • integer 1 = On, 0 = Off
key #pto

PTO has been switched on or off.

  • integer 1 = On, 0 = Off
key #aux

Auxillary switch pressed. This switch does nothing by default and was added as an additional button for use in modding!

  • integer 1 = On, 0 = Off
key #gear

Gear has been changed.

  • integer -1 = Reverse, 0 = Neutral, 1-5 = Gears
key #handbrake

Parking brake has been changed.

  • integer 1 = Released, 0 = Applied
key #animation sendable

Specified animation will play on specified avatar.

  • message (CSV)[(key) Avatar UUID, (string) Animation name]
key #accelerator

Acclerator pedal has been pressed or released.

  • integer 1 = Pressed, 0 = Released
key #brake

Brake pedal has been pressed or released.

  • integer 1 = Pressed, 0 = Released
key #horn

Horn is starting or stopping.

  • integer 1 = Horn On, 0 = Horn Off
key #bullhorn

Bullhorn is starting or stopping.

  • integer 1 = Horn On, 0 = Horn Off
key #twotones

Alternate siren turned on or off.

  • integer 1 = On, 0 = Off
key #siren

Siren turned on or off.

  • integer 1 = On, 0 = Off
key #lightbar

Lightbar turned on or off.

  • integer 1 = On, 0 = Off
key #strobes

Strobes turned on or off.

  • integer 1 = On, 0 = Off
key #tone sendable

Siren tone button pressed.

key #indicators

Indicators or hazard warning lights have been changed.

  • integer 0 = Off, 1 = Left, 2 = Right, 3 = Both
  • message (optional) "no_stalk" - To supress stalk sound.
key #heater sendable

Cab air conditioning has been toggled.

key #bonnet

Bonnet (or 'hood' for Americans) has been opened or closed.

  • integer 1 = Opened, 0 = Closed
key #access

Access level has been changed.

  • integer 0 = Everyone, 1 = Group, 2 = Owner
key #repair sendable

Will repair all damage and refill all fluids.

key #turn_speed sendable

Increase or decrease the turn speed.

  • integer -1 = Decrease, 1 = Increase
key #buzzer

Warning buzzer on or off.

  • integer 1 = On, 0 = Off
key #cruise

Cruise mode started / stopped. Cruise mode will kick in once the vehicle reaches a certain speed, and will stop when you fall below that speed.

  • integer 1 = On, 0 = Off
key #equip_id

Equipment ID of the vehicle.

  • integer id
key #pump_rpm

Sent when the RPM level of the pump is changed.

  • integer RPM Percentage - 100 = Max
key #after_edit

Sent when [ AFTER EDIT ] is used from the vehicle menu. This is a good time to delete un-needed scripts, or correct physics shapes etc.

key #fill_oil sendable

Will fill the oil tank.

  • message (float) Amount to fill, in % out of 100
key #fill_def sendable

Will fill the DEF tank.

  • message (float) Amount to fill, in % out of 100
key #fill_coolant sendable

Will fill the coolant tank.

  • message (float) Amount to fill, in % out of 100
key #fill_damage sendable

Will repair engine damage.

  • message (float) Amount to repair, in % out of 100
key #drain

Sent when the tank drain starts / stops.

  • integer 1 = Start, 0 = Stop
key #cavitation

Sent when cavitation starts or stops.

  • integer 1 = On, 0 = Off
  • message (float) Volume
key #pump_idle

Sent when the pump enters or leaves idle.

  • integer 1 = True, 0 = False
key #cooling_loop

Sent when the cooling loop is added or removed.

  • integer 1 = Added, 0 = Removed
key #high_pressure

Sent when the high pressure pump is enabled or disabled.

  • integer 1 = Enabled, 0 = Disabled
key #pump_use_fluids

This is sent to tell the Engine script to use some fuel / DEF / coolant while the pump is in use.

key #basic_turning sendable

Sent to enable or disable basic turning mode.

  • integer 1 = Basic Turning, 0 = Realistic Turning
key #bottle_texture

Sent when the breathing apparatus bottle texture is changed.

  • message Texture UUID
key #equipment_return

Sent when a piece of equipment is returned.

  • message Equipment name
key #gantry_handles sendable

Sent to enable or disable the ladder gantry handles.

  • integer 1 = Enable, 0 = Disable, 2 = Toggle
key #135_ladder sendable

Sent to enable or disable the 13.5m ladder.

  • integer 1 = Enable, 0 = Disable, 2 = Toggle
key #electric_plug

Sent when the electric charging plug changes.

  • integer 1 = Plugged in, 0 = Unplugged
key #reverse_camera sendable

Sent to toggle the reverse camera.

key #debug_mode sendable

Sent to enable or disable debug mode. When debug mode is enabled, link messages will be shown in local chat.

  • integer 1 = Enabled, 0 = Disabled
key #pump_prime

Sent when the pump prime button has been pressed.

key #tank_refill

Tank refill lever has been opened / closed.

  • integer 1 = Opened, 0 = Closed
key #use_fuel sendable

Sent to toggle the NTBI Global fuel system (Toggle fuel usage).

key #restock sendable

Will replenish all equipment, vests, and BA bottles in the vehicle.

key #do_ignition sendable

Sent to toggle engine ignition.

key #do_pto sendable

Sent to toggle PTO.

key #do_handbrake sendable

Sent to toggle parking brake.

key #do_lightbar sendable

Sent to change lightbar.

  • integer 0 = Off, 1 = On, 2 = Toggle
key #do_strobes sendable

Sent to change strobes.

  • integer 0 = Off, 1 = On, 2 = Toggle
key #do_siren sendable

Sent to change siren.

  • integer 0 = Off, 1 = On, 2 = Toggle
key #do_aux sendable

Sent to change aux.

  • integer 0 = Off, 1 = On, 2 = Toggle
key #do_headlights sendable

Sent to change headlights.

  • integer 0 = Off, 1 = On, 2 = Toggle
key #do_damage sendable

Sent to add or remove vehicle damage. (Be careful what value you send)

  • message (float) % out of 100, damage to do. - to DO damage, otherwise value will be repaired.
key #indicator_left sendable

Will toggle the left indicator.

key #indicator_right sendable

Will toggle the right indicator.

key #indicator sendable

Sent to change the indicators or hazard warning lights.

  • integer 0 = Off, 1 = Left, 2 = Right, 3 = Hazard
key #do_door sendable

Sent to open or close a door or window. You must specify a door name OR link number, but you don't need to provide both. For the door and window changes 0 = Closed, 1 = Open, 2 = Toggle, 3 = No change. If you wanted to open the window on door left you would send "Door Left,0,3,1"

  • message (CSV)[
    (string, optional) Door Name
    (int, optional) Door link number
    (int) Door change
    (int) Window change]
key #get_oil sendable

Will make the #oil link message be sent with value of the oil tank.

key #get_def sendable

Will make the #def link message be sent with value of the def tank.

key #get_coolant sendable

Will make the #coolant link message be sent with value of the coolant tank.

key #get_fuel sendable

Will make the #fuel link message be sent with value of the fuel tank.

key #get_damage sendable

Will make the #damage link message be sent with value of vehicle damage.

key #equip_id_please sendable

Will make the #equip_id link message be sent with the vehicles equipment id. Manners are important! :D

key #emg_ext_colour sendable

Will change the colour of vehicles emergency lighting. (Lightbar casing, exterior colour)

  • message (vector) LSL Colour
key #emg_flash_colour sendable

Will change the colour of vehicles emergency lighting flashes.

  • message (vector) LSL Colour
key #emg_point_colour sendable

Will change the colour of vehicles emergency point lighting.

  • message (vector) LSL Colour
key #strobe_change_pattern sendable

Will change the flash pattern of object message is sent from.. so only use this inside of something that flashes.

  • integer Face that flashes
key #colour_quick sendable

Will change the colour of the hose reels.

  • message (vector) LSL Colour