Difference between revisions of "GetBirdsEnabled"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
{{Client function}}
 
This function will tell you if the birds are enabled or disabled.  
 
This function will tell you if the birds are enabled or disabled.  
  
Line 10: Line 12:
  
 
==Example==  
 
==Example==  
This example outputs a message the Birds current state.
+
This example outputs the Birds state.
 
<section name="Client" class="client" show="true">
 
<section name="Client" class="client" show="true">
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
function areBirdsEnabled()
 
function areBirdsEnabled()
  outputChatBox("The birds are currently ".. (getBirdsEnabled() and "Enabled" or "Disabled") ..".") -- output if the Birds are Enabled or Disabled.
+
outputChatBox("The birds are currently ".. (getBirdsEnabled() and "Enabled" or "Disabled") ..".") -- Output the birds state.
 
end
 
end
addCommandHandler("birds",areBirdsEnabled) -- add the command handler.
+
addCommandHandler("birds", areBirdsEnabled) -- Add the command handler attached to the function "areBirdsEnabled".
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</section>
 
</section>

Latest revision as of 06:08, 10 April 2014

This function will tell you if the birds are enabled or disabled.

Syntax

bool getBirdsEnabled ()

Returns

Returns true if the birds are enabled or false if the birds are disabled.

Example

This example outputs the Birds state.

Click to collapse [-]
Client
function areBirdsEnabled()
	outputChatBox("The birds are currently ".. (getBirdsEnabled() and "Enabled" or "Disabled") ..".") -- Output the birds state.
end
addCommandHandler("birds", areBirdsEnabled) -- Add the command handler attached to the function "areBirdsEnabled".

Requirements

Minimum supported server 1.3
Minimum supported client 1.3

Note: Using this function/event requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.3" client="1.3" />

See Also

BETA: FROM VERSION 1.5.8 r20675 ONWARDS
BETA: FROM VERSION 1.5.8 r20718 ONWARDS
BETA: FROM VERSION 1.5.8 r20718 ONWARDS