FastCast2 Documentation

1. Caster

1.1 Serial Mode (FastCast.new())

Serial Caster runs all cast simulations on the main thread. Simpler.

local caster = FastCast2.new()
caster:Init(movementMode, useObjectCache, template, cacheSize, cacheHolder)

1.1.1 Parameters

Parameter	Type	Description
movementMode	"BulkMoveTo" | "Motor6D"	How cosmetic bullets are moved each frame
useObjectCache	boolean	Enable part pooling via ObjectCache
Template	BasePart | Model?	Template for ObjectCache
CacheSize	number?	Pre-allocated cache size (default 500)
CacheHolder	Instance?	Parent for cached objects (default workspace)

1.1.2 Events

Events are assigned directly on the caster before or after Init:

caster.Hit = function(cast, result, velocity, cosmeticBullet) end
caster.Pierced = function(cast, result, velocity, cosmeticBullet) end
caster.LengthChanged = function(cast, lastPoint, rayDir, rayDisplacement) end
caster.CastFire = function(cast, origin, direction, velocity, behavior) end
caster.CastTerminating = function(cast) end
caster.CanPierce = function(cast, result, velocity, cosmeticBullet) -> boolean end

1.1.3 Movement Modes

• "BulkMoveTo" — Uses workspace:BulkMoveTo() each frame. (General/Default)
• "Motor6D" — Uses Motor6D instances (Transform property). Better for performance.

Switch modes at runtime with caster:SetMovementMode(mode).

1.1.4 ObjectCache

ObjectCache reuses projectile parts:

caster:Init("BulkMoveTo", true, projectileTemplate, 500, workspace)

---

1.2 Parallel Mode (FastCast.newParallel())

Parallel Caster runs cast simulations on separate Actor VMs.

local caster = FastCast2.newParallel()
caster:Init(
    numWorkers,          -- number of worker VMs (must be > 1)
    newParent,           -- Folder to place FastCastVMs
    newName,             -- name for FastCastVMs folder
    ContainerParent,     -- parent for worker containers
    VMContainerName,     -- name for containers
    VMname,              -- name for each worker VM
    movementMode,        -- "BulkMoveTo" or "Motor6D"
    fastCastEventsModule,-- optional ModuleScript
    useObjectCache,      -- enable ObjectCache
    template,            -- ObjectCache template
    cacheSize,           -- ObjectCache size
    CacheHolder          -- ObjectCache parent
)

[!NOTE] FastCastParallel does not use Caster.CanPierce

Only available on FastCastEventsModule for performance reasons

1.2.1 Parameters

Parameter	Type	Description
numWorkers	number	Number of Actor VMs. Must be > 1.
newParent	Folder	Parent for the FastCastVMs Folder
newName	string	Name for the FastCastVMs Folder
ContainerParent	Folder	Parent for worker VM Containers
VMContainerName	string	Name for VM Containers
VMname	string	Name given to each worker VM
movementMode	"BulkMoveTo" | "Motor6D"	Movement method
fastCastEventsModule	ModuleScript?	FastCastEvents module
useObjectCache	boolean	Enable ObjectCache
template	BasePart | Model?	ObjectCache template
cacheSize	number?	ObjectCache size
CacheHolder	Instance?	ObjectCache parent

1.2.2 How It Works

• Creates Actor-based worker VMs using VMsDispatcher
• Each worker handles multiple casts in parallel via ConnectParallel
• Fire requests are round-robined to workers for load balancing

1.2.3 Configuration Methods

caster:SetFastCastEventsModule(moduleScript)  -- Parallel only
caster:SetMovementModeEnabled(enabled, mode)
caster:SetObjectCacheEnabled(enabled, template?, cacheSize?, cacheHolder?)

---

1.3 Fire Methods

All three casters share the same fire interface:

caster:RaycastFire(origin, direction, velocity, BehaviorData?)
caster:BlockcastFire(origin, Size, direction, velocity, BehaviorData?)
caster:SpherecastFire(origin, Radius, direction, velocity, BehaviorData?)

• velocity can be a Vector3 (exact velocity) or number (speed in the fire direction)
• BehaviorData is a FastCastBehavior created with FastCast2.newBehavior()

-- Raycast: simple line-of-sight
caster:RaycastFire(Vector3.new(0, 5, 0), Vector3.new(0, 0, -1), 500, behavior)

-- Blockcast: pass a Vector3 size after origin
caster:BlockcastFire(Vector3.new(0, 5, 0), Vector3.new(2, 4, 2), Vector3.new(0, 0, -1), 500, behavior)

-- Spherecast: pass a radius after origin
caster:SpherecastFire(Vector3.new(0, 5, 0), 3, Vector3.new(0, 0, -1), 500, behavior)

---

1.4 Cast Manipulation (static methods on FastCast)

-- Getters
FastCast:GetPositionCast(cast) → Vector3
FastCast:GetVelocityCast(cast) → Vector3
FastCast:GetAccelerationCast(cast) → Vector3

-- Setters (modifies trajectory, triggers CancelHighResCast)
FastCast:SetVelocityCast(cast, velocity) → ()
FastCast:SetAccelerationCast(cast, acceleration) → ()
FastCast:SetPositionCast(cast, position) → ()

-- Adders (relative modification)
FastCast:AddPositionCast(cast, position) → ()
FastCast:AddVelocityCast(cast, velocity) → ()
FastCast:AddAccelerationCast(cast, acceleration) → ()

-- Termination
FastCast:TerminateCast(cast) → ()

In parallel mode, call caster:SyncChangesToCast(cast) after any Set/Add to push state to the worker VM.

-- Example: modify a cast mid-flight
local function onHit(cast, result, velocity, bullet)
	-- Deflect the projectile upward on hit
	FastCast.SetVelocityCast(cast, Vector3.new(0, 100, 0))
	FastCast.SetPositionCast(cast, result.Position + Vector3.new(0, 2, 0))

	-- In parallel mode, push changes to the worker VM
	if caster.SyncChangesToCast then
		caster:SyncChangesToCast(cast)
	end
end

---

1.5 Lifecycle

caster:Destroy()  -- Cleans up all resources, actors, caches

---

2. FastCastBehavior

Created via FastCast2.newBehavior(). Configuration for cast behavior:

local behavior = FastCast2.newBehavior()
behavior.MaxDistance = 500
behavior.RaycastParams = RaycastParams.new()
behavior.RaycastParams.FilterType = Enum.RaycastFilterType.Exclude
behavior.RaycastParams.FilterDescendantsInstances = {character}
behavior.Acceleration = Vector3.new(0, -workspace.Gravity, 0)
behavior.CosmeticBulletContainer = workspace.Projectiles
behavior.CosmeticBulletTemplate = ReplicatedStorage.Projectile
behavior.HighFidelityBehavior = FastCastEnums.HighFidelityBehavior.Automatic
behavior.HighFidelitySegmentSize = 0.5
behavior.VisualizeCasts = true
behavior.VisualizeCastSettings = {
	Debug_SegmentColor = Color3.new(1, 1, 0),
	Debug_HitColor = Color3.new(1, 0, 0),
}

Field	Type	Default	Description
RaycastParams	RaycastParams?	nil	Filter rules for raycasting
MaxDistance	number	1000	Max range before auto-termination
Acceleration	Vector3	(0,0,0)	Constant acceleration applied each frame
HighFidelityBehavior	number	1	Default(1) / Automatic(2) / Always(3)
HighFidelitySegmentSize	number	0.5	Segment size for sub-stepping
CosmeticBulletTemplate	BasePart?	nil	Visual projectile part
CosmeticBulletContainer	Instance?	nil	Parent for non-cached bullets
AutoIgnoreContainer	boolean	true	Auto-adds container to filter list
VisualizeCasts	boolean	false	Debug visualization toggle
VisualizeCastSettings	table	(defaults)	Debug viz colors, sizes, lifetimes
UserData	any	nil	Arbitrary data accessible on the cast

Event Configuration

behavior.FastCastEventsConfig = {
    UseLengthChanged = false,
    UseHit = true,
    UsePierced = true,
    UseCastTerminating = true,
    UseCanPierce = true,
    UseCastFire = true
}

behavior.FastCastEventsModuleConfig = {  -- Parallel only
    UseLengthChanged = false,
    UseHit = true,
    UsePierced = true,
    UseCastTerminating = true,
    UseCanPierce = true,
    UseCastFire = true
}

---

3. ActiveCastData

3.1 What is ActiveCast

ActiveCast represents a projectile in flight. It's a pure data structure (AoS) exposed to users, while internally FastCast2 uses SoA for performance.

3.2 Data Structure

cast.ID: number              -- Unique identifier
cast.CFrame: CFrame          -- Current cosmetic bullet CFrame
cast.UserData: any           -- From behavior.UserData
cast.CastVariant: {          -- Cast type info
    CastType: number,        -- 1=Raycast, 2=Blockcast, 3=Spherecast
    Size: Vector3?,          -- Blockcast only
    Radius: number?          -- Spherecast only
}

3.3 StateInfo

cast.StateInfo.TotalRuntime: number
cast.StateInfo.HighFidelityBehavior: number
cast.StateInfo.HighFidelitySegmentSize: number
cast.StateInfo.IsActivelyResimulating: boolean
cast.StateInfo.CancelHighResCast: boolean
cast.StateInfo.VisualizeCasts: boolean
cast.StateInfo.VisualizeCastSettings: VisualizeCastSettings
cast.StateInfo.FastCastEventsConfig: FastCastEventsConfig
cast.StateInfo.FastCastEventsModuleConfig: FastCastEventsModuleConfig  -- Parallel only

cast.StateInfo.Trajectory = {
    StartTime: number,
    EndTime: number,            -- -1 if still active
    Origin: Vector3,
    InitialVelocity: Vector3,
    Acceleration: Vector3
}

3.4 RayInfo

cast.RayInfo.Parameters: RaycastParams
cast.RayInfo.WorldRoot: WorldRoot
cast.RayInfo.MaxDistance: number
cast.RayInfo.CosmeticBulletObject: Instance?
cast.RayInfo.Size: Vector3       -- Blockcast only
cast.RayInfo.Radius: number      -- Spherecast only

---

4. FastCastEventsModule

Parallel-mode only. A ModuleScript that returns a FastCastEvents table for direct (non-BindableEvent) callbacks, providing better performance for high-frequency events like LengthChanged.

-- In a ModuleScript (e.g., ReplicatedStorage.FastCastEventsModule)
local module = {}

module.Hit = function(cast, result, velocity, bullet)
    print("Hit:", result.Instance)
end

module.CanPierce = function(cast, result, velocity, bullet)
    return result.Instance:GetAttribute("CanPierce") == true
end

module.LengthChanged = function(cast, lastPoint, rayDir, displacement)
    -- Called every frame - more efficient than BindableEvent routing
end

return module

Register it:

caster:SetFastCastEventsModule(pathToModule)

Note: Not available in Serial mode, it use direct event callbacks instead.

---

5. High-Fidelity Behavior

Mode	Value	Description
Default	1	Single cast per frame. Fastest, lowest accuracy.
Automatic	2	On hit, subdivides the frame's cast into sub-segments to find precise hit point.
Always	3	Always subdivides every frame. Most accurate, most expensive.

HighFidelitySegmentSize controls the segment size for sub-stepping (default 0.5 studs).