SetVehicleWindowOpen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (fix version)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.6|7405|This function sets the vehicle window state.}}
{{New feature/item|3.0153|1.5.3|7405|This function sets the vehicle window state.}}


== Syntax ==
== Syntax ==
Line 21: Line 21:


=== Returns ===
=== Returns ===
* True if vehicle is unstreamed and window ID is between valid values or when is streamed and has specified window.
* when the vehicle is not streamed in:
* False if vehicle is streamed and don't have specified window or window ID is not between valid values.
** if the window ID does lie within the acceptable list of values, it will return '''true'''
** if the window ID does ''not'' lie within the acceptable list of values, it will return '''false'''
* when the vehicle is streamed in:
** if the vehicle has the window, it will return '''true'''
** if the vehicle does not have the window, it will return '''false'''


== Example ==
== Example ==
Line 42: Line 46:
outputChatBox( "Window switched!" )
outputChatBox( "Window switched!" )
else
else
outputChatBox( "You don't have window!")
outputChatBox( "You don't have window!" )
end
end
else
else

Latest revision as of 17:14, 22 October 2016

This function sets the vehicle window state.

Syntax

bool setVehicleWindowOpen ( vehicle theVehicle, int window, bool open )

Required arguments

  • theVehicle: The vehicle that you wish to change the window state.
  • window: An integer representing window.
    • 0: motorbike shield
    • 1: rear window
    • 2: right front window
    • 3: right back window
    • 4: left front (driver) window
    • 5: left back window
    • 6: windshield
  • open: Boolean which represent window open state.

Returns

  • when the vehicle is not streamed in:
    • if the window ID does lie within the acceptable list of values, it will return true
    • if the window ID does not lie within the acceptable list of values, it will return false
  • when the vehicle is streamed in:
    • if the vehicle has the window, it will return true
    • if the vehicle does not have the window, it will return false

Example

Command which allow player to open window which near sits.

local seatWindows = {
	[0] = 4,
	[1] = 2,
	[2] = 5,
	[3] = 3
}

addCommandHandler("window",
	function()
		local veh = getPedOccupiedVehicle( localPlayer )
		if veh then
			local seat = getPedOccupiedVehicleSeat( localPlayer )
			if seatWindows[seat] and setVehicleWindowOpen( veh, seatWindows[seat], not isVehicleWindowOpen( veh, seatWindows[seat] ) ) then
				outputChatBox( "Window switched!" )
			else
				outputChatBox( "You don't have window!" )
			end
		else
			outputChatBox( "You must be in vehicle!" )
		end
	end
)

See also