factorio-scenario-ExpCluster/locale/StdLib/game.lua

--- Game module
-- @module Game
-- @usage local Game = require('stdlib/game')

Game = {} --luacheck: allow defined top

Game.VALID_FILTER = function(v)
    return v.valid
end

--- Messages all players currently connected to the game
-- @tparam string msg message to send to players
-- @param[opt] condition condition to be true for the player to be messaged
-- @treturn int the number of players who received the message. Offline players are not counted as having received the message.
function Game.print_all(msg, condition)
    local num = 0
    for _, player in pairs(game.connected_players) do
        if condition == nil or select(2, pcall(condition, player)) then
            player.print(msg)
            num = num + 1
        end
    end
    return num
end

return Game