Engine

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. This allows for 'Capture the Flag' to be made games very easily, which was the reason for its creation.

Summary

Properties

Properties inherited from Tool
  • read parallel

    Controls whether the player can drop the tool.

  • read parallel

    Relates to whether or not the tool can be used.

  • read parallel

    Stores the tool's "grip" properties as one CFrame.

  • hidden
    not replicated
    read parallel

    One of the properties that specifies a Tool's orientation in a character's hand. This represents the R02, R12, and R22 values of the Grip CFrame's rotation matrix.

  • hidden
    not replicated
    read parallel

    The positional offset of a Tool weld matrix.

  • hidden
    not replicated
    read parallel

    One of the properties that specifies a Tool's orientation in a character's hand. This represents the R00, R10, and R20 values of the Grip CFrame's rotation matrix.

  • hidden
    not replicated
    read parallel

    One of the properties that specifies a Tool's orientation in a character's hand. This represents the R01, R11, and R21 values of the Grip CFrame's rotation matrix.

  • The ManualActivationOnly property controls whether the Tool can be activated without executing Tool:Activate().

  • read parallel

    Determines whether a Tool functions without a handle.

  • read parallel

    Controls the message displayed when the player's mouse hovers over the tool in their backpack.

Properties inherited from BackpackItem
  • 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. However they have been deprecated and developers are advised to design their own systems which will be more flexible and reliable.

Methods

Events