Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:1.30

Description

Description:This script "thumps" or "shakes" the player screen once. It is used as a visual effect to indicate impact, but is otherwise harmless.

Syntax

Syntax:[unit, magnitude] call fn_vbs_injury_thump
Parameters:
  • unit: Object - Unit to have the screen thumped.
  • magnitude: Number - How much to "thump" the player screen (0-1, 1 means maximum screen thump).
Return Value:Nothing

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
[player, 0.2] call fn_vbs_injury_thump;

Additional Information

See also: 
Multiplayer:The script should (but does not have to) be executed where unit is local.
Problems: 

Notes