Flag
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Memory category	BaseParts

Tags: [Deprecated]

Member index 1

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

726 Change Default of TeamColor from to
693 Change MemoryCategory of Flag from PhysicsParts to BaseParts
564 Change MemoryCategory of Flag from Instances to PhysicsParts
553 Change Default of TeamColor from to
486 Change ThreadSafety of TeamColor from ReadOnly to ReadSafe
462 Change ThreadSafety of TeamColor from to ReadOnly
206 Change Tags of Flag from [] to [Deprecated]
47 Add TeamColor
47 Add Flag

Members 1

TeamColor
CreatorHub

Type		Default
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 safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

726 Change Default of TeamColor from to
553 Change Default of TeamColor from to
486 Change ThreadSafety of TeamColor from ReadOnly to ReadSafe
462 Change ThreadSafety of TeamColor from to ReadOnly
47 Add TeamColor

Reference API Roblox

Engine API

Website

Related