Skip to content

Flags (Old)

Mike Liu edited this page Oct 17, 2016 · 4 revisions

NOTE: As of v0.19 these flags are no longer relevant. Please see the updated flag docs HERE.

FoxGuard has a list of flags associated with events. Here is a list, along with their identifiers. Note that when these flags are displayed, they may be stylized a little bit differently than the identifier. However, always use the identifier in commands.

Flags can also have parents. When an event fires, handlers check to see if the flag is defined. If it is not, they then check if their parent is defined, and this continues until a defined flag is found or until the top of the hierarchy is reached. This allows the setting of groups of flags at once. If a flag and its parent are both defined, the child flag takes priority. This way you can disable an entire family of events, but then leave one specific type enabled.

Flags finally have default behavior. This is used when the flag completely passes through all handlers. Note that the default of the specific flag is used, and not any of its parents'. It is generally allow if the flag is used to deny an action, and it is generally deny if the flag is used to give a kind of buff.

Identifier Parent Default Description
- root none n/a Fired for all events. Parent of all other flags.
- block root true Fired for block events
blockplace block true Fired when a block is placed in the world
blockbreak block true Fired when a block is broken in the world
blockmodify block true Fired when a block changes
- blockclick block true Fired when a player clicks a block
blockattack blockclick true Fired when a player left clicks a block
blockinteract blockclick true Fired when a player right clicks a block
- entityclick root true Fired when a player clicks an entity
entityattack entityclick true Fired when a player left clicks an entity
entityinteract entityclick true Fired when a player right clicks an entity
playerattack entityattack true Fired when a player left clicks another player (This does not include all PVP!)
- spawnmob root true Fired when a mob spawns
spawnmobhostile spawnmob true Fired when a hostile mob spawns
spawnmobpassive spawnmob true Fired when a neutral mob spawns
- playerpass root true Fired when a player enters or leaves an area. Determined by handlers.
playerenter playerpass true Fired when a player enters an area.
playerleave playerpass true Fired when a player leaves an area.

Entries with a * exist in code, but are not actually triggered. As such, disabling them will have no effect yet. They will, however, be implemented soon.

Entries with a - are just parents of flags, and they themselves are not fired.

Clone this wiki locally