bz resetFlags

From BZFlagWiki
Revision as of 21:03, 23 March 2013 by Alezakos (Talk | contribs) (add the new keepTeamFlags parameter)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call.


BZF_API void bz_resetFlags ( bool onlyUnused, bool keepTeamFlags = false );


name type value description
onlyUnused bool only reset non-player flags
keepTeamFlags bool don't reset team flags (defaults to false)


This API function will force all flags to be reset and respawned. If the onlyUnused parameter is true, then flags carried by players will not be reset, otherwise all flags will be reset. If the keepTeamFlags parameter is true, then team flags will not be reset.