Module f3x-wrapper
The main module of f3x-wrapper
Info:
- Copyright: bqmb3 2024
- License: MIT
- Author: bqmb3
Functions
| F3X:RecolorHandle (NewColor) | Recolors the handle of a part. |
| F3X:CloneParts (Items, Parent) | Clones multiple parts and sets their parent. |
| F3X:Clone (Item[, Parent=Item.Parent]) | Clones a single part and sets its parent. |
| F3X:CreatePart (PartType, Position[, Parent=workspace]) | Creates a new part of the specified type at the given position. |
| F3X:CreateGroup (Type, Parent, Items) | Creates a group (Model or Folder) containing the specified items. |
| F3X:Ungroup (Groups) | Ungroups the specified groups. |
| F3X:SetParent (Items, Parent) | Sets the parent of the specified items. |
| F3X:SetNames (Items, Name) | Sets the name of the specified items. |
| F3X:SetName (Item, Name) | Sets the name of a single item. |
| F3X:RemoveParts (Objects) | Removes the specified parts. |
| F3X:Remove (Object) | Removes a single part. |
| F3X:UndoRemovedParts (Objects) | Undoes the removal of the specified parts. |
| F3X:UndoRemove (Object) | Undoes the removal of a single part. |
| F3X:MoveParts (Changes) | Moves the specified parts to the given CFrame. |
| F3X:Move (Part, CFrame) | Moves a single part to the given CFrame. |
| F3X:MoveTo (Part, Position) | Moves a part to the specified position. |
| F3X:ResizeParts (Changes) | Resizes the specified parts. |
| F3X:Resize (Part, Size[, cf=Part.CFrame]) | Resizes a single part. |
| F3X:RotateParts (Changes) | Rotates the specified parts. |
| F3X:Rotate (Part, CFrame) | Rotates a single part. |
| F3X:SetColors (Changes) | Sets the color of the specified parts. |
| F3X:SetColor (Part, Color) | Sets the color of a single part. |
| F3X:SetPartsSurfaces (Changes) | Sets the surfaces of the specified parts. |
| F3X:SetSurfaces (Part, Surfaces) | Sets the surfaces of a single part. |
| F3X:SetSurface (Part, Face, SurfaceType) | Sets the surface of a single face of a part. |
| F3X:CreateLights (Changes) | Creates lights on the specified parts. |
| F3X:CreateLight (Part, LightType) | Creates a single light on a part. |
| F3X:SetLights (Changes) | Sets the properties of the specified lights. |
| F3X:CreateDecorations (Changes) | Creates decorations on the specified parts. |
| F3X:SetDecorations (Changes) | Sets the properties of the specified decorations. |
| F3X:CreateMeshes (Changes) | (deprecated) Creates meshes on the specified parts. |
| F3X:CreateMeshesOnParts (Objects) | Creates meshes on the specified parts. |
| F3X:SetMeshes (Changes) | Sets the properties of the specified meshes. |
| F3X:CreateTextures (Changes) | Creates textures on the specified parts. |
| F3X:SetTextures (Changes) | Sets the properties of the specified textures. |
| F3X:SetAnchors (Changes) | Sets the anchored state of the specified parts. |
| F3X:Anchor (Part) | Anchors a single part. |
| F3X:Unanchor (Part) | Unanchors a single part. |
| F3X:SetCollisions (Changes) | Sets the collision state of the specified parts. |
| F3X:SetCollision (Part, CanCollide) | Sets the CanCollide property of single part. |
| F3X:SetMaterials (Changes) | Sets the material properties of the specified parts. |
| F3X:SetMaterial (Part, Material) | Sets the material of single part. |
| F3X:SetTransparency (Part, Transparency) | Sets the transparency of single part. |
| F3X:SetReflectance (Part, Reflectance) | Sets the reflectance of single part. |
| F3X:CreateWelds (Parts, TargetPart) | Creates welds between the specified parts and the target part. |
| F3X:RemoveWelds (Welds) | Removes the specified welds. |
| F3X:UndoRemovedWelds (Welds) | Undoes the removal of the specified welds. |
| F3X:Export (Parts) | Exports the specified parts. |
| F3X:IsHttpServiceEnabled () | Checks if the HTTP service is enabled. |
| F3X:ExtractMeshFromAsset (AssetId) | Extracts a mesh from the specified asset ID. |
| F3X:ExtractImageFromDecal (DecalAssetId) | Extracts an image from the specified decal asset ID. |
| F3X:SetMouseLockEnabled (Enabled) | Enables or disables mouse lock. |
| F3X:SetLocked (Items, Locked) | Sets the locked state of the specified items. |
| F3X:GetSelectedParts () | Gets the currently selected parts. |
Tables
| PartMovement | F3X:MoveParts(), F3X:RotateParts() |
| PartResize | F3X:ResizeParts() |
| SurfaceProperties | F3X:SetPartsSurfaces() |
| LightCreation | F3X:CreateLights() |
| LightProperties | F3X:SetLights() |
| DecorationCreation | F3X:CreateDecorations() |
| DecorationProperties | F3X:SetDecorations() |
| MeshProperties | F3X:SetMeshes() |
| TextureCreation | F3X:CreateTextures() |
| TextureProperties | F3X:SetTextures() |
| AnchorProperties | F3X:SetAnchors() |
| CollisionProperties | F3X:SetCollisions() |
| MaterialProperties | F3X:SetMaterials() |
Functions
- F3X:RecolorHandle (NewColor)
-
Recolors the handle of a part.
Parameters:
- NewColor BrickColor New color for the handle
Returns:
-
nil
- F3X:CloneParts (Items, Parent)
-
Clones multiple parts and sets their parent.
Parameters:
- Items table Parts to clone
- Parent Instance Parent instance
Returns:
-
{Instance,...}
Cloned parts
- F3X:Clone (Item[, Parent=Item.Parent])
-
Clones a single part and sets its parent.
Parameters:
- Item Instance Part to clone
- Parent Instance Parent instance (default Item.Parent)
Returns:
-
Instance
Cloned part
- F3X:CreatePart (PartType, Position[, Parent=workspace])
-
Creates a new part of the specified type at the given position.
Parameters:
- PartType 'Normal', 'Truss', 'Wedge', 'Corner', 'Cylinder', 'Ball', 'Seat', 'VehicleSeat' or 'Spawn' Type of the part
- Position CFrame Position of the part
- Parent Instance Parent instance, defaults to workspace (default workspace)
Returns:
-
BasePart
Created part
- F3X:CreateGroup (Type, Parent, Items)
-
Creates a group (Model or Folder) containing the specified items.
Parameters:
- Type "Model" or "Folder" Type of the group
- Parent Instance Parent instance
- Items {Instance,...} Items to group
Returns:
-
Model or Folder
Created group
- F3X:Ungroup (Groups)
-
Ungroups the specified groups.
Parameters:
- Groups {Instance,...} Groups to ungroup
Returns:
-
{Instance,...}
Ungrouped items
- F3X:SetParent (Items, Parent)
-
Sets the parent of the specified items.
Parameters:
- Items {Instance,...} Items to reparent
- Parent Instance New parent instance
Returns:
-
nil
- F3X:SetNames (Items, Name)
-
Sets the name of the specified items.
Parameters:
- Items {Instance,...} Items to rename
- Name string or {string,...} New name(s)
Returns:
-
nil
- F3X:SetName (Item, Name)
-
Sets the name of a single item.
Parameters:
- Item Instance Item to rename
- Name string New name
Returns:
-
nil
- F3X:RemoveParts (Objects)
-
Removes the specified parts.
Parameters:
- Objects {Instance,...} Parts to remove
Returns:
-
nil
- F3X:Remove (Object)
-
Removes a single part.
Parameters:
- Object Instance Part to remove
Returns:
-
nil
- F3X:UndoRemovedParts (Objects)
-
Undoes the removal of the specified parts.
Parameters:
- Objects {Instance,...} Parts to restore
Returns:
-
nil
- F3X:UndoRemove (Object)
-
Undoes the removal of a single part.
Parameters:
- Object Instance Part to restore
Returns:
-
nil
- F3X:MoveParts (Changes)
-
Moves the specified parts to the given CFrame.
Parameters:
- Changes {PartMovement,...} Parts and their new CFrames
Returns:
-
nil
- F3X:Move (Part, CFrame)
-
Moves a single part to the given CFrame.
Parameters:
- Part BasePart Part to move
- CFrame CFrame New CFrame
Returns:
-
nil
- F3X:MoveTo (Part, Position)
-
Moves a part to the specified position.
Parameters:
- Part BasePart Part to move
- Position Vector3 New position
Returns:
-
nil
- F3X:ResizeParts (Changes)
-
Resizes the specified parts.
Parameters:
- Changes {PartResize,...} Parts and their new sizes and CFrames
Returns:
-
nil
- F3X:Resize (Part, Size[, cf=Part.CFrame])
-
Resizes a single part.
Parameters:
- Part BasePart Part to resize
- Size Vector3 New size
- cf CFrame new CFrame (default Part.CFrame)
Returns:
-
nil
- F3X:RotateParts (Changes)
-
Rotates the specified parts.
Parameters:
- Changes {PartMovement,...} Parts and their new CFrames
Returns:
-
nil
- F3X:Rotate (Part, CFrame)
-
Rotates a single part.
Parameters:
- Part BasePart Part to rotate
- CFrame CFrame New CFrame
Returns:
-
nil
- F3X:SetColors (Changes)
-
Sets the color of the specified parts.
Parameters:
- Changes {{Part:BasePart,Color:Color3},...} Parts and their new colors
Returns:
-
nil
- F3X:SetColor (Part, Color)
-
Sets the color of a single part.
Parameters:
- Part BasePart Part to color
- Color Color3 New color
Returns:
-
nil
- F3X:SetPartsSurfaces (Changes)
-
Sets the surfaces of the specified parts.
Parameters:
- Changes {SurfaceProperties,...} Parts and their new surfaces
Returns:
-
nil
- F3X:SetSurfaces (Part, Surfaces)
-
Sets the surfaces of a single part.
Parameters:
- Part BasePart Part to set surfaces
- Surfaces {["Top", "Front", "Bottom", "Right", "Left" or "Back"]:Enum.SurfaceType} New surfaces
Returns:
-
nil
- F3X:SetSurface (Part, Face, SurfaceType)
-
Sets the surface of a single face of a part.
Parameters:
- Part BasePart Part to set surface
- Face "Top", "Front", "Bottom", "Right", "Left" or "Back" Face to set
- SurfaceType Enum.SurfaceType New surface type
Returns:
-
nil
- F3X:CreateLights (Changes)
-
Creates lights on the specified parts.
Parameters:
- Changes {LightCreation,...} Parts and their light types
Returns:
-
{SpotLight, PointLight or SurfaceLight,...}
Created lights
- F3X:CreateLight (Part, LightType)
-
Creates a single light on a part.
Parameters:
- Part Instance Part to create light on
- LightType "SpotLight", "PointLight" or "SurfaceLight" Type of light
Returns:
-
Instance
Created light
- F3X:SetLights (Changes)
-
Sets the properties of the specified lights.
Parameters:
- Changes {LightProperties,...} A table containing information about the lights to be set.
Returns:
-
nil
- F3X:CreateDecorations (Changes)
-
Creates decorations on the specified parts.
Parameters:
- Changes {DecorationCreation,...} Parts and their decoration types
Returns:
-
{Smoke, Fire or Sparkles,...}
Created decorations
- F3X:SetDecorations (Changes)
-
Sets the properties of the specified decorations.
Parameters:
- Changes {DecorationProperties,...} Decorations and their new properties
Returns:
-
nil
- F3X:CreateMeshes (Changes)
-
(deprecated) Creates meshes on the specified parts.
Parameters:
- Changes {{["Part"]:BasePart},...} Parts to create meshes on
Returns:
-
{SpecialMesh,...}
Created meshes
See also:
- F3X:CreateMeshesOnParts (Objects)
-
Creates meshes on the specified parts.
Parameters:
- Objects {BasePart,...} Parts to create meshes on
Returns:
-
{SpecialMesh,...}
Created meshes
- F3X:SetMeshes (Changes)
-
Sets the properties of the specified meshes.
Parameters:
- Changes {MeshProperties,...} Meshes and their new properties
Returns:
-
nil
- F3X:CreateTextures (Changes)
-
Creates textures on the specified parts.
Parameters:
- Changes {TextureCreation,...} Parts and their texture types
Returns:
-
{Texture or Decal,...}
Created textures
- F3X:SetTextures (Changes)
-
Sets the properties of the specified textures.
Parameters:
- Changes {TextureProperties,...} Textures and their new properties
Returns:
-
nil
- F3X:SetAnchors (Changes)
-
Sets the anchored state of the specified parts.
Parameters:
- Changes {AnchorProperties,...} Parts and their anchored states
Returns:
-
nil
- F3X:Anchor (Part)
-
Anchors a single part.
Parameters:
- Part BasePart Part to anchor
Returns:
-
nil
- F3X:Unanchor (Part)
-
Unanchors a single part.
Parameters:
- Part BasePart Part to unanchor
Returns:
-
nil
- F3X:SetCollisions (Changes)
-
Sets the collision state of the specified parts.
Parameters:
- Changes {CollisionProperties,...} Parts and their collision states
Returns:
-
nil
- F3X:SetCollision (Part, CanCollide)
-
Sets the CanCollide property of single part.
Parameters:
- Part BasePart The part
- CanCollide boolean Whether the part can collide with other parts.
Returns:
-
nil
- F3X:SetMaterials (Changes)
-
Sets the material properties of the specified parts.
Parameters:
- Changes {MaterialProperties,...} Parts and their new material properties
Returns:
-
nil
- F3X:SetMaterial (Part, Material)
-
Sets the material of single part.
Parameters:
- Part BasePart The part
- Material Enum.Material The material of the part.
Returns:
-
nil
- F3X:SetTransparency (Part, Transparency)
-
Sets the transparency of single part.
Parameters:
- Part BasePart The part
- Transparency number The transparency of the part.
Returns:
-
nil
- F3X:SetReflectance (Part, Reflectance)
-
Sets the reflectance of single part.
Parameters:
- Part BasePart The part
- Reflectance number The reflectance of the part.
Returns:
-
nil
- F3X:CreateWelds (Parts, TargetPart)
-
Creates welds between the specified parts and the target part.
Parameters:
- Parts {BasePart,...} Parts to weld
- TargetPart BasePart Target part
Returns:
-
{Weld,...}
Created welds
- F3X:RemoveWelds (Welds)
-
Removes the specified welds.
Parameters:
- Welds {Weld,...} Welds to remove
Returns:
-
number
Number of removed welds
- F3X:UndoRemovedWelds (Welds)
-
Undoes the removal of the specified welds.
Parameters:
- Welds {Weld,...} Welds to restore
Returns:
-
nil
- F3X:Export (Parts)
-
Exports the specified parts.
Parameters:
- Parts {BasePart,...} Parts to export
Returns:
-
string or nil
Exported data
- F3X:IsHttpServiceEnabled ()
-
Checks if the HTTP service is enabled.
Returns:
-
boolean
True if enabled, false otherwise
- F3X:ExtractMeshFromAsset (AssetId)
-
Extracts a mesh from the specified asset ID.
Parameters:
- AssetId number Asset ID
Returns:
-
any
Extracted mesh
- F3X:ExtractImageFromDecal (DecalAssetId)
-
Extracts an image from the specified decal asset ID.
Parameters:
- DecalAssetId number Decal asset ID
Returns:
-
string
Extracted image
- F3X:SetMouseLockEnabled (Enabled)
-
Enables or disables mouse lock.
Parameters:
- Enabled boolean True to enable, false to disable
Returns:
-
nil
- F3X:SetLocked (Items, Locked)
-
Sets the locked state of the specified items.
Parameters:
Returns:
-
nil
- F3X:GetSelectedParts ()
-
Gets the currently selected parts.
Returns:
-
{Instance,...}
A table containing the selected parts
Tables
- PartMovement
-
F3X:MoveParts(), F3X:RotateParts()
Fields:
- Part Instance Part to move
- CFrame CFrame New CFrame
See also:
- PartResize
-
F3X:ResizeParts()
Fields:
- Part Instance Part to resize
- CFrame CFrame New CFrame
- Size Vector3 New Size
See also:
- SurfaceProperties
-
F3X:SetPartsSurfaces()
Fields:
- Part Instance The part
- Surfaces {["Top", "Front", "Bottom", "Right", "Left" or "Back"]:Enum.SurfaceType},...} The face and type of surface to be set.
See also:
- LightCreation
-
F3X:CreateLights()
Fields:
- Part Instance The part
- LightType "SpotLight", "PointLight" or "SurfaceLight" The type of light to be created.
See also:
- LightProperties
-
F3X:SetLights()
Fields:
- Part Instance The part to which the light belongs.
- LightType "SpotLight", "PointLight" or "SurfaceLight" The type of light to be set.
- Range number The range of the light. (optional)
- Brightness number The brightness of the light. (optional)
- Color Color3 The color of the light. (optional)
- Shadows boolean Whether the light should cast shadows. (optional)
- Face Enum.NormalId The face of the part to which the light is applied. (optional)
- Angle number The angle of the light. (optional)
See also:
- DecorationCreation
-
F3X:CreateDecorations()
Fields:
- Part Instance The part
- DecorationType "Smoke", "Fire" or "Sparkles" The type of decoration to be created.
See also:
- DecorationProperties
-
F3X:SetDecorations()
Fields:
- Part Instance The part to which the decoration belongs.
- DecorationType "Smoke", "Fire" or "Sparkles" The type of decoration to be set.
- Color Color3 The color of the decoration. (optional)
- Opacity number The opacity of the decoration. (optional)
- RiseVelocity number The speed of decoration particles move during their lifetime. (optional)
- Size number The size of the decoration. (optional)
- SecondaryColor Color3 The secondary color of the fire decoration. (optional)
- SparkleColor Color3 The sparkle color of the decoration. (optional)
See also:
- MeshProperties
-
F3X:SetMeshes()
Fields:
- Part Instance The part to which the mesh belongs.
- VertexColor Vector3 The vertex color of the mesh. (optional)
- MeshType Enum.MeshType The mesh type of mesh. (optional)
- Scale Vector3 The scale of the mesh. (optional)
- Offset Vector3 The offset of the mesh. (optional)
- MeshId string The asset ID of the mesh. (optional)
- TextureId string The asset ID of the mesh texture. (optional)
See also:
- TextureCreation
-
F3X:CreateTextures()
Fields:
- Part Instance The part to which the texture belongs.
- Face Enum.NormalId The face of the part where the texture will be applied.
- TextureType "Texture" or "Decal" The type of the texture.
See also:
- TextureProperties
-
F3X:SetTextures()
Fields:
- Part Instance The part to which the texture belongs.
- Face Enum.NormalId The face of the part where the texture is.
- TextureType "Texture" or "Decal" The type of the texture.
- Texture string The asset ID of the texture. (optional)
- Transparency number The transparency of the texture. (optional)
- StudsPerTileU number Horizonal size of a texture tile in studs (optional)
- StudsPerTileV number Vertical size of a texture tile in studs (optional)
See also:
- AnchorProperties
-
F3X:SetAnchors()
Fields:
- Part Instance The part to anchor or unanchor.
- Anchored boolean Whether the part is anchored.
See also:
- CollisionProperties
-
F3X:SetCollisions()
Fields:
- Part Instance The part
- CanCollide boolean Whether the part can collide with other parts.
See also:
- MaterialProperties
-
F3X:SetMaterials()
Fields:
- Part Instance The part
- Material Enum.Material The material of the part. (optional)
- Transparency number The transparency of the part. (optional)
- Reflectance number The reflectance of the part. (optional)
See also: