SetCameraShakeLevel: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Client function}}__NOTOC__ {{Note|Not present in any version yet.}} {{New feature/item|3.0150|1.5|| Function sets the camera shake level. }} == Syntax == <syntaxhighlight lang="lua"> boo...") |
mNo edit summary |
||
| (9 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Client function}} | __NOTOC__ | ||
{{ | {{Client function}} | ||
{{New feature/item|3.0150|1.5|| | {{Deprecated|setCameraDrunkLevel|Deprecated as of 1.6.0 r21795.}} | ||
{{New feature/item|3.0150|1.5|7343|This function sets the camera shake level (as seen on the ''Are you going to San Fierro?'' singleplayer mission).}} | |||
}} | |||
== Syntax == | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setCameraShakeLevel ( int shakeLevel ) | bool setCameraShakeLevel ( int shakeLevel ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required | ===Required arguments=== | ||
*'''shakeLevel''': | *'''shakeLevel''': an integer between 0 and 255, which represents the camera shake intensity level. | ||
=== Returns === | ===Returns=== | ||
Returns ''true'' if camera shake level was changed, ''false'' | Returns ''true'' if the camera shake level was changed, ''false'' if the required argument is incorrect or missing. | ||
== Example == | ==Example== | ||
This example adds a ''/camshake'' command which allows any player to manually change its camera shake level. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler("camshake", | addCommandHandler( "camshake", | ||
function( _, level ) | |||
local level = math.floor( level ) | |||
if level and level >=0 and level <= 255 then | |||
setCameraShakeLevel( level ) | |||
outputChatBox( "Camera shake level updated to " .. level .. "." ) | |||
else | |||
outputChatBox( "Camera shake level must be between 0 and 255." ) | |||
end | |||
end | |||
) | ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See | ==See also== | ||
{{Client_camera_functions}} | {{Client_camera_functions}} | ||
[[hu:setCameraShakeLevel]] | |||
[[RO:setCameraShakeLevel]] | |||
Latest revision as of 14:28, 11 June 2023
|
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use setCameraDrunkLevel instead. Deprecated as of 1.6.0 r21795. |
This function sets the camera shake level (as seen on the Are you going to San Fierro? singleplayer mission).
Syntax
bool setCameraShakeLevel ( int shakeLevel )
Required arguments
- shakeLevel: an integer between 0 and 255, which represents the camera shake intensity level.
Returns
Returns true if the camera shake level was changed, false if the required argument is incorrect or missing.
Example
This example adds a /camshake command which allows any player to manually change its camera shake level.
addCommandHandler( "camshake",
function( _, level )
local level = math.floor( level )
if level and level >=0 and level <= 255 then
setCameraShakeLevel( level )
outputChatBox( "Camera shake level updated to " .. level .. "." )
else
outputChatBox( "Camera shake level must be between 0 and 255." )
end
end
)