Flag
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
Controls whether the player can drop the tool.
Relates to whether or not the tool can be used.
Stores the tool's "grip" properties as one CFrame.
Represents the R02, R12, and R22 values of the grip CFrame rotation matrix.
The positional offset of the tool's weld matrix.
Represents the R00, R10, and R20 values of the grip CFrame rotation matrix.
Represents the R01, R11, and R21 values of the grip CFrame rotation matrix.
Controls whether the Tool can be activated without executing Tool:Activate().
Determines whether a Tool functions without a handle.
Controls the message displayed when the player's mouse hovers over the tool in their backpack.
Properties
The texture icon that is displayed for a tool in the player's backpack.
Properties
Sets the level of detail on the model for experiences with instance streaming enabled.
Controls the model streaming behavior on Models when instance streaming is enabled.
The primary part of the Model, or nil if not explicitly set.
Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though Model/ScaleTo was called on it.
Determines where the pivot of a Model which does not have a set Model.PrimaryPart is located.
Properties
Methods
Methods inherited from ToolMethods
Methods
Sets this model to be persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition.
Returns a description of a volume that contains all parts of a Model.
Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model.PrimaryPart if it is set.
Returns all the Player objects that this model object is persistent for. Behavior varies based on whether this method is called from a Script or a LocalScript.
Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via Model/ScaleTo.
Moves the PrimaryPart to the given position. If a primary part has not been specified, the root part of the model will be used.
Makes this model no longer persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal.
Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1.
Shifts a Model by the given Vector3 offset, preserving the model's orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object.
Methods
Gets the pivot of a PVInstance.
Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame.
Events
Events inherited from ToolEvents
Fires when the player clicks while the tool is equipped.
Fires when the player releases their click while the tool is equipped and activated.
Fires when the tool is equipped.
Fires when the tool is unequipped.