fn vbs injury thump (VBS2)

From Bohemia Interactive Community
Jump to: navigation, search
VBS2 references on this site are not maintained anymore, and may be outdated!
Please use the new, dedicated VBS2 Wiki instead:
http://resources.bisimulations.com/wiki
Introduced in Virtual Battlespace 2 version 1.30

Click on the images for descriptions

Introduced in

Game:
Virtual Battlespace 2
Version:
1.30

Description

Description:
This script "thumps" or "shakes" the player's 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 screen thumped
magnitude: Number - 0 to 1; how much to "thump" the player's screen (1 means max screen thump)
Return Value:
Nothing
Note

As this is a function, 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 them. More here.

Examples

Example 1:
[player, 0.2] call fn_vbs_injury_thump;

Additional Information

Multiplayer:
The script should (but doesn't have to) be executed where unit is local.

Notes

Notes

+ Add Note

Only post proven facts here. Use the talk page or the forums for discussions.

Notes

Bottom Section