SetBirdsEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Needs Example}}__NOTOC__{{Client function}} This function allows you to disable the flying birds. ==Syntax== <syntaxhighlight lang="lua"> bool setBirdsEnabled ( bool enable ) </syntaxhighlight> ===Req...")
 
(Remove obsolete Requirements section)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Needs Example}}__NOTOC__{{Client function}}
__NOTOC__
{{Client function}}
This function allows you to disable the flying birds.
This function allows you to disable the flying birds.


Line 13: Line 14:
Returns ''true'' if the birds state was changed succesfully, ''false'' if an invalid argument was specified.
Returns ''true'' if the birds state was changed succesfully, ''false'' if an invalid argument was specified.


==Example==
==Example==  
This example Enables or Disables the Birds.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- todo
function setBirdsState()
setBirdsEnabled(not getBirdsEnabled()) -- Disable the Birds if they're enabled, either Enable them.
outputChatBox("The birds are now ".. (getBirdsEnabled() and "Enabled" or "Disabled") ..".") -- Output the new Birds state.
end
addCommandHandler("birds",setBirdsState) -- Add the command handler attached to the function "setBirdsState".
</syntaxhighlight>
</syntaxhighlight>
 
</section>
==Requirements==
{{Requirements|1.3|1.3|}}


==See Also==
==See Also==
{{World functions}}
{{Client_world_functions}}

Latest revision as of 15:41, 7 November 2024

This function allows you to disable the flying birds.

Syntax

bool setBirdsEnabled ( bool enable )

Required Arguments

  • enabled: A boolean value determining if birds should be shown. Use true to show the birds and false to hide them.

Returns

Returns true if the birds state was changed succesfully, false if an invalid argument was specified.

Example

This example Enables or Disables the Birds.

Click to collapse [-]
Client
function setBirdsState()
	setBirdsEnabled(not getBirdsEnabled()) -- Disable the Birds if they're enabled, either Enable them.
	outputChatBox("The birds are now ".. (getBirdsEnabled() and "Enabled" or "Disabled") ..".") -- Output the new Birds state.
end
addCommandHandler("birds",setBirdsState) -- Add the command handler attached to the function "setBirdsState".

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetBirdsEnabled?oldid=81055"