GetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP)
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
{{Server client function}}
__NOTOC__
This function is used to retrieve the text on the number plate of a specified vehicle.
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehiclePlateText ( vehicle theVehicle )
string getVehiclePlateText ( vehicle theVehicle )
</syntaxhighlight>  
</syntaxhighlight>
 
{{OOP||[[vehicle]]:getPlateText|plateText|setVehiclePlateText}}
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theVehicle:''' the [[vehicle]] that you wish to retrieve the plate text from.
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns a ''string'' that corresponds to the plate on the text, ''false'' if a bad argument was passed or if it is not a vehicle. Every vehicle (including planes, boats, etc.) has a numberplate, even if it's not visible.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Client" class="client" show="true">
This example does...
This example outputs the text on the license plate of the vehicle the player is driving to the chatbox.
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function outputLicensePlate ( command )
blabhalbalhb --abababa
    if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
--This line does this...
        -- if they are in a vehicle
mooo
        local vehicle = getPedOccupiedVehicle ( localPlayer ) --let's get the vehicle
        local plateText = getVehiclePlateText ( vehicle ) --get the license plate text
        if plateText then -- if there was a license plate,
            outputChatBox ( "Your license plate is: " .. plateText )-- output it to the chatbox
        else
            outputChatBox ( "Your vehicle has no license plate." )
        end
    else
        outputChatBox ( "You're not in a vehicle." )
    end
end
-- add our function as a handler to the "plate" command
addCommandHandler( "plate", outputLicensePlate )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Vehicle functions}}
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Latest revision as of 20:33, 13 October 2014

This function is used to retrieve the text on the number plate of a specified vehicle.

Syntax

string getVehiclePlateText ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getPlateText(...)
Variable: .plateText
Counterpart: setVehiclePlateText


Required Arguments

  • theVehicle: the vehicle that you wish to retrieve the plate text from.

Returns

Returns a string that corresponds to the plate on the text, false if a bad argument was passed or if it is not a vehicle. Every vehicle (including planes, boats, etc.) has a numberplate, even if it's not visible.

Example

Click to collapse [-]
Client

This example outputs the text on the license plate of the vehicle the player is driving to the chatbox. 

function outputLicensePlate ( command )
    if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
         -- if they are in a vehicle
         local vehicle = getPedOccupiedVehicle ( localPlayer ) --let's get the vehicle
         local plateText = getVehiclePlateText ( vehicle ) --get the license plate text
         if plateText then -- if there was a license plate,
             outputChatBox ( "Your license plate is: " .. plateText )-- output it to the chatbox
         else
             outputChatBox ( "Your vehicle has no license plate." )
         end
    else
         outputChatBox ( "You're not in a vehicle." )
    end
end
-- add our function as a handler to the "plate" command
addCommandHandler( "plate", outputLicensePlate )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehiclePlateText?oldid=42593"