Browsing StarfallEx's section
โ† Back to ACE
Back to StarfallEx

SFEX.game.getWindSpeed

S๐Ÿท๏ธ Game

Part of StarfallEx namespace

๐Ÿ”— External
game.getWindSpeed(pos)
View on GitHub|lua/starfall/libs_sh/game.lua:164
๐Ÿ“‹ Has LDoc๐Ÿ‘๏ธ 0 viewsUpdated 1 month ago

Description

Returns the wind's velocity at a given position, as influenced by current map's env_wind entities

Parameters

NameTypeDescription
pos?VectorOptional position to get wind speed at. If specified, wind controllers with windradius other than -1 will be taken into account, if the point is within their radius. If omitted, only the global wind controller will be used (if one exists). This argument will be ignored on client-side and will be treated as nil because the position of env_wind is not currently networked to clients

Returns

TypeDescription
VectorThe current wind velocity at a given position

Examples

No examples available.

Used In

No usages found in the codebase.