ShowCol: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0159|1.5.8|20840|Shows collision previews for developers.}}
{{Added feature/item|1.5.9|1.5.8|20844|Shows collision previews for developers ([[colshape]]s in wireframe, useful when writing scripts).}}
{{Note|This function only works in development mode.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool showCol ( bool state )</syntaxhighlight>
<syntaxhighlight lang="lua">bool showCol ( bool state )</syntaxhighlight>
===Required Arguments===  
===Required Arguments===  
*'''state:''' true/false
*'''state:''' A [[boolean]] indicating if the collision previews should be enabled or disabled.
===Returns===
===Returns===
* If the operation is executed, it returns 'true', otherwise it returns 'false'.
* Returns ''true'' if the function is successful, ''false'' otherwise.


==Example==
==Example==
You can refer to the example below.
You can refer to the example below:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
setDevelopmentMode(true)
setDevelopmentMode (true)


addCommandHandler("devdebug",
addCommandHandler ("devdebug",
     function()
     function ()
         showCol(not isShowCollisionsEnabled())
         showCol (not isShowCollisionsEnabled())
     end
     end
)
)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20840|}}


==See Also==
==See Also==
{{Client_utility_functions}}
{{Client_utility_functions}}

Latest revision as of 17:27, 7 November 2024

Shows collision previews for developers (colshapes in wireframe, useful when writing scripts).

[[{{{image}}}|link=|]] Note: This function only works in development mode.

Syntax

bool showCol ( bool state )

Required Arguments

  • state: A boolean indicating if the collision previews should be enabled or disabled.

Returns

  • Returns true if the function is successful, false otherwise.

Example

You can refer to the example below: 

setDevelopmentMode (true)

addCommandHandler ("devdebug",
    function ()
        showCol (not isShowCollisionsEnabled())
    end
)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/ShowCol?oldid=81301"