Flag

Show Deprecated
Deprecated

The Flag is a unit spawned with a FlagStand object, and will respawn when captured. When a player touches this object's Handle, which must be a child of the Flag object, which is a Part named "Handle", the flag will be added to the player's backpack and will appear in their hand. A player cannot select other weapons while carrying a flag, and can drop the flag at anytime by pressing "Backspace" on the keyboard. If the player carrying a flag steps onto another FlagStand of a different team color, the flag will be removed from the player's backpack and a point will be added to the user's leaderstats, if provided. The flag will then regenerate at the originating flag stand.

Summary

Properties

Properties inherited from ToolProperties inherited from BackpackItem
  • TextureId:ContentId
    Read Parallel

    The texture icon that is displayed for a tool in the player's backpack.

Properties inherited from ModelProperties inherited from PVInstance

Methods

Methods inherited from ToolMethods inherited from ModelMethods inherited from PVInstance

Events

Events inherited from Tool

Properties

TeamColor

Read Parallel

The Team this flag is for. Corresponds with the TeamColors in the Teams service.

The Flag and FlagStand objects were created to allow developers to make 'capture the flag' style games quickly.

Methods

Events