SetJetpackMaxHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Server client function}}
This function changes the maximum flying height of jetpack.
This function changes the maximum flying height of jetpack.


Line 13: Line 13:
===Returns===
===Returns===
Returns ''true'' if successful, ''false'' otherwise.
Returns ''true'' if successful, ''false'' otherwise.


==Example==
==Example==
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
This example shows you a command to set your maximum jetpack height.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function setMyMaxHeight ( cmd, value )
local height = tonumber ( value ) -- Get the number of the value
if height > -20 then -- If the height is higher than -20
local succes = setJetpackMaxHeight ( height ) -- Set the maximum height
if succes then -- If it's succesfully changed
outputChatBox ( "You've set you maximum jetpack height to "..height.."!", 0, 255, 0 ) -- Send the client a succes message
else -- If there was something wrong
outputChatBox ( "Failed to set your maximum jetpack height to "..height.."!", 255, 0, 0 ) -- Send the client an error message
end
else -- If the given value was below -20
outputChatBox ( "Failed to change you jetpack height! Please use a number above -20." , 255, 0, 0 ) -- Send the client an error message
end
end
addCommandHandler ( "maxheight", setMyMaxHeight ) -- Add the command handler
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 16:20, 5 August 2012

This function changes the maximum flying height of jetpack.

Syntax

bool setJetpackMaxHeight ( float Height )

Required Arguments

  • Height: The max height starting at approximately -20.

Returns

Returns true if successful, false otherwise.

Example

Click to collapse [-]
Client

This example shows you a command to set your maximum jetpack height.

function setMyMaxHeight ( cmd, value )
	local height = tonumber ( value ) -- Get the number of the value
	if height > -20 then -- If the height is higher than -20
		local succes = setJetpackMaxHeight ( height ) -- Set the maximum height
		if succes then -- If it's succesfully changed
			outputChatBox ( "You've set you maximum jetpack height to "..height.."!", 0, 255, 0 ) -- Send the client a succes message
		else -- If there was something wrong
			outputChatBox ( "Failed to set your maximum jetpack height to "..height.."!", 255, 0, 0 ) -- Send the client an error message
		end
	else -- If the given value was below -20
		outputChatBox ( "Failed to change you jetpack height! Please use a number above -20." , 255, 0, 0 ) -- Send the client an error message
	end
end
addCommandHandler ( "maxheight", setMyMaxHeight ) -- Add the command handler

See Also