Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Flag

The Flag object helps you make 'capture the flag' style games.

This class is deprecated. It exists only for backward compatibility, and should not be used for new work.
Memory categoryBaseParts
Tags: [Deprecated]

Member index 1

HistoryMember
731TeamColor: BrickColor
inherited from Tool
731CanBeDropped: bool
731Enabled: bool
731Grip: CFrame
731ManualActivationOnly: bool
731RequiresHandle: bool
486ToolTip: string
573Activate(): null
573Deactivate(): null
462Activated()
462Deactivated()
483Equipped(mouse: Mouse)
462Unequipped()
inherited from BackpackItem
731TextureContent: Content
731TextureId: ContentId
inherited from Model
731LevelOfDetail: ModelLevelOfDetail
731ModelStreamingMode: ModelStreamingMode
731PrimaryPart: BasePart
731Scale: float
731WorldPivot: CFrame
573AddPersistentPlayer(playerInstance: Player = Player): null
573BreakJoints(): null
607GetBoundingBox(): (CFrame, Vector3)
462GetExtentsSize(): Vector3
731GetModelCFrame(): CFrame
731GetModelSize(): Vector3
648GetPersistentPlayers(): Instances
731GetPrimaryPartCFrame(): CFrame
562GetScale(): float
573MakeJoints(): null
573MoveTo(position: Vector3): null
573RemovePersistentPlayer(playerInstance: Player = Player): null
731ResetOrientationToIdentity(): null
573ScaleTo(newScaleFactor: float): null
731SetIdentityOrientation(): null
731SetPrimaryPartCFrame(cframe: CFrame): null
573TranslateBy(delta: Vector3): null
731breakJoints(): null
731makeJoints(): null
731move(location: Vector3): null
731moveTo(location: Vector3): null
inherited from PVInstance
731Origin: CFrame
731Pivot Offset: CFrame
576GetPivot(): CFrame
573PivotTo(targetCFrame: CFrame): null
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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.

History 10

Members 1

TeamColor

TypeDefault
BrickColor

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.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 6

Settings