GetElementInterior: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:


===Returns===
===Returns===
Returns an integer for the interior if 'theElement' is valid, 'false' otherwise.
Returns an ''integer'' for the interior if 'theElement' is valid, ''false'' otherwise.


==Example==
==Example==
This example shows a player if he is outside or not, when he enters the command 'AmIOutside'.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "AmIOutside", "AmIOutside" )
function AmIOutside ( player, command )
function AmIOutside ( source, key )
   if ( getElementInterior(player) == 0 ) then
   if ( getElementInterior ( source ) == 0 ) then
     outputChatBox ( "Yes you are outside " .. getClientName(player), player )
     outputChatBox ( "Yes you are outside " .. getClientName ( source ) )
   else
   else
     outputChatBox ( "No you aren't outside " .. getClientName ( source ) )
     outputChatBox ( "No you aren't outside " .. getClientName(player), player )
   end
   end
end
end
addCommandHandler ( "AmIOutside", AmIOutside )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Element functions}}
{{Element functions}}

Revision as of 21:29, 28 July 2007

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 )

Required Arguments

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

Returns

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

Example

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

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

See Also