PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Flag

Show deprecated

Flag

Show 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.


Properties

BrickColor

TeamColor

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

Inherited from Tool: Show Hide

string

ToolTip

This property controls the message that will be displayed when the player's mouse is hovering over the tool in their backpack.
bool

RequiresHandle

If set to false the tool will function without a handle.
bool

ManualActivationOnly

When set to true, the tool will only fire `Tool/Activated` when `Tool/Activate` is called. This also suppresses the `ContextActionService`'s `ContextActionService/BindActivate` function.

When set to false, mouse clicks (when the tool is equipped) will also fire `Tool/Activated`.

Vector3

GripUp

[NotReplicated]
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.
Vector3

GripRight

[NotReplicated]
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.
Vector3

GripPos

[NotReplicated]
The positional offset of a Tool weld matrix.
Vector3

GripForward

[NotReplicated]
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.
CFrame

Grip

Stores the Tool's Grip properties as one CFrame.
bool

Enabled

Relates to whether or not the tool can be used.
bool

CanBeDropped

If true, when the backspace button is pressed the tool will be parented to the workspace and removed from the player's backpack. If false, when the backspace button is pressed the tool will go back to the Player's Backpack.

Inherited from BackpackItem: Show Hide

Content

TextureId

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

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Tool: Show Hide

void

Deactivate ( )

Simulates the deactivation of a Tool. Tool must be equipped.
void

Activate ( )

Simulates a click on a Tool. Tool must be equipped.

Inherited from Instance: Show Hide

Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string describing the `Instance`'s ancestry.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Tool: Show Hide

RBXScriptSignal

Unequipped ( )

Fired when the tool is unequipped
RBXScriptSignal

Equipped ( Instance mouse )

Fired when the tool is equipped.
RBXScriptSignal

Deactivated ( )

Fired when the left mouse button is released.
RBXScriptSignal

Activated ( )

Fired when the player clicks while a tool is equipped.

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.