GetElementInterior: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by 6 users not shown)
Line 7: Line 7:
int getElementInterior ( element theElement )
int getElementInterior ( element theElement )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:getInterior|interior|setElementInterior}}


===Required Arguments===
===Required Arguments===
Line 15: Line 16:


==Example==
==Example==
<section show="true" name="Server" class="server">
This example shows a player if he is outside or not, when he enters the command 'AmIOutside'.
This example shows a player if he is outside or not, when he enters the command 'AmIOutside'.
<section show="true" name="Server" class="server">
''This example will not work as is in a client side script, due to different event names or slightly different syntax.''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function AmIOutside ( thePlayer, command )
function AmIOutside ( thePlayer, command )
     if ( getElementInterior(thePlayer) == 0 ) then
     if ( getElementInterior(thePlayer) == 0 ) then
         outputChatBox ( "Yes you are outside " .. getClientName(thePlayer), thePlayer )
         outputChatBox ( "Yes you are outside " .. getPlayerName(thePlayer), thePlayer )
     else
     else
         outputChatBox ( "No you aren't outside " .. getClientName(thePlayer), thePlayer )
         outputChatBox ( "No you aren't outside " .. getPlayerName(thePlayer), thePlayer )
     end
     end
end
end
Line 32: Line 32:
==See Also==
==See Also==
{{Element functions}}
{{Element functions}}
[[de:getElementInterior]]
[[ar:getElementInterior]]

Latest revision as of 16:13, 17 April 2016

This function allows you to retrieve the interior of any element. An interior is the current loaded place, 0 being outside.

Syntax

int getElementInterior ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:getInterior(...)
Variable: .interior
Counterpart: setElementInterior


Required Arguments

  • theElement: The element of which you'd like to retrieve the interior

Returns

Returns an int for the interior if theElement is valid, false otherwise.

Example

Click to collapse [-]
Server

This example shows a player if he is outside or not, when he enters the command 'AmIOutside'.

function AmIOutside ( thePlayer, command )
    if ( getElementInterior(thePlayer) == 0 ) then
        outputChatBox ( "Yes you are outside " .. getPlayerName(thePlayer), thePlayer )
    else
        outputChatBox ( "No you aren't outside " .. getPlayerName(thePlayer), thePlayer )
    end
end
addCommandHandler ( "AmIOutside", AmIOutside )

See Also