Skip to content

LOS Mask utilities #5537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

LOS Mask utilities #5537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions LuaRules/Utilities/LosInfo.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
local function TranslateLosBitToBools(bit) -- turns Spring.GetUnitLosState into booleans. This makes it easier to read code.
local inLOS = bit%2 == 1
local inRadar = bit%4 >= 2
local prevLOS = bit%8 >= 4
local contRadar = bit > 7
return inLOS, inRadar, prevLOS, contRadar
end

local function IsInLOS(bit)
return bit%2 == 1
end

local function IsInRadar(bit)
return bit%4 >= 2
end

local function WasInLOS(bit)
return bit%8 >= 4
end

local function IsContRadar(bit)
return bit > 7
end

local function TranslateLosBitToTable(bit) -- turns Spring.GetUnitLosState into a nice human readable table.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC the Spring.GetLosState functions that return a bitmask have a bool option to return this table instead already?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure, documentation seems to be is missing. Can't find again.

local inLOS, inRadar, prevLOS, contRadar = TranslateLosBitToBools(bit)
return {inLOS = inLOS, inRadar = inRadar, prevLOS = prevLOS, contRadar = contRadar}
end

local function LosInfoToBit(inLOS, inRadar, prevLOS, contRadar) -- turns bools into a number for SetUnitLosState.
local ret = 0
if inLOS then
ret = ret + 1
end
if inRadar then
ret = ret + 2
end
if prevLOS then
ret = ret + 4
end
if contRadar then
ret = ret + 8
end
return ret
end

local LosInfo = {TranslateLosBitToBools = TranslateLosBitToBools, LosInfoToBit = LosInfoToBit, TranslateLosBitToTable = TranslateLosBitToTable, InLOS = IsInLOS, InRadar = IsInRadar, WasInLOS = WasInLOS, IsContRadar = IsContRadar}
Spring.Utilities.LosInfo = LosInfo