Skip to main content

TypeDefinitions

Types

Type definitions for strict-typing.

Types​

vaildcast​

</>
type vaildcast = ActiveCastData | ActiveBlockcastData | ActiveSpherecastData

A type that can be either an ActiveCast or an ActiveBlockcast.

FastCastEventsModule​

</>
type FastCastEventsModule = ModuleScript

A moduleScript that will be required by ActiveCast

FastCastEvents​

</>
type FastCastEvents = {
CanPierce: CanPierceFunction,
Hit: OnHitFunction,
Pierced: OnPiercedFunction,
LengthChanged: OnLengthChangedFunction,
CastTerminating: OnCastTerminatingFunction,
CastFire: OnCastFireFunction
}

A table of callback functions (events/hooks) used by ActiveCast. These functions are invoked by ActiveCast during a lifecycle (e.g., length updates, pierce checks).

CanPierceFunction​

</>
type CanPierceFunction = (
cast: vaildcast,
result: RaycastResult,
segmentVelocity: Vector3,
cosmeticBulletObject: Instance?
) → boolean

Callback used to decide whether a cast should pierce and continue after a hit.

OnHitFunction​

</>
type OnHitFunction = (
cast: vaildcast,
result: RaycastResult,
segmentVelocity: Vector3,
cosmeticBulletObject: Instance?
) → ()

Callback fired when the cast hits something (non-piercing).

OnPierceFunction​

</>
type OnPierceFunction = (
cast: vaildcast,
result: RaycastResult,
segmentVelocity: Vector3,
cosmeticBulletObject: Instance?
) → ()

Callback fired when the cast pierces something.

OnLengthChangedFunction​

</>
type OnLengthChangedFunction = (
cast: vaildcast,
lastPoint: Vector3,
rayDir: Vector3,
rayDisplacement: number,
segmentVelocity: Vector3,
cosmeticBulletObject: Instance?
) → ()

Callback fired when the cast's length changes as it updates.

OnCastTerminatingFunction​

</>
type OnCastTerminatingFunction = (cast: vaildcast) → ()

Callback fired right as an ActiveCast is terminating.

OnCastFireFunction​

</>
type OnCastFireFunction = (
cast: vaildcast,
lastPoint: Vector3,
rayDir: Vector3,
segmentVelocity: Vector3,
behavior: FastCastBehavior
) → ()

Callback fired when a cast is initially fired.

ObjectCache​

</>
type ObjectCache = {
GetPart: (
ObjectCache,
PartCFrame: CFrame
) → BasePart,
ReturnPart: (
ObjectCache,
Part: BasePart
) → (),
Update: (ObjectCache) → (),
ExpandCache: (
ObjectCache,
Amount: number
) → (),
SetExpandAmount: (
ObjectCache,
Amount: number
) → (),
IsInUse: (
ObjectCache,
Object: BasePart
) → boolean,
Destroy: (ObjectCache) → ()
}

Represents a ObjectCache object.

Caster​

</>
type Caster = {
WorldRoot: WorldRoot,
LengthChanged: Signal<OnLengthChangedFunction> | OnLengthChangedFunction,
Hit: Signal<OnHitFunction> | OnHitFunction,
Pierced: Signal<OnPiercedFunction> | OnPiercedFunction,
CastTerminating: Signal<OnCastTerminatingFunction> | OnCastTerminatingFunction,
CastFire: Signal<OnCastFireFunction> | OnCastFireFunction,
Dispatcher: Dispatcher.Dispatcher,
ObjectCache: ObjectCache,
AlreadyInit: boolean,
ObjectCacheEnabled: boolean,
BulkMoveEnabled: boolean,
FastCastEventsModule: FastCastEventsModule,
Init: (
self: Caster,
numWorkers: number,
newParent: Folder,
newName: string,
ContainerParent: Folder,
VMContainerName: string,
VMname: string,
useBulkMoveTo: boolean,
FastCastEventsModule: ModuleScript,
useObjectCache: boolean,
Template: BasePart | Model,
CacheSize: number,
CacheHolder: Instance
) → (),
RaycastFire: (
Caster,
Origin: Vector3,
Direction: Vector3,
Velocity: Vector3 | number,
Behavior: FastCastBehavior
) → (),
BlockcastFire: (
self: Caster,
Origin: Vector3,
Size: Vector3,
Direction: Vector3,
Velocity: Vector3 | number,
Behavior: FastCastBehavio
) → (),
SetBulkMoveEnabled: (
self: Caster,
enabled: boolean
) → (),
SetObjectCacheEnabled: (
self: Caster,
enabled: boolean,
Template: BasePart | Model,
CacheSize: number,
CacheHolder: Instance
) → (),
SetFastCastEventsModule: (
self: Caster,
moduleScript: ModuleScript
) → (),
AddVelocityCast: (
Caster,
cast: vaildcast,
velocity: Vector3
) → (),
SetVelocityCast: (
Caster,
cast: vaildcast,
velocity: Vector3
) → (),
GetVelocityCast: (
Caster,
cast: vaildcast,
velocity: Vector3
) → Vector3,
AddAccelerationCast: (
Caster,
cast: vaildcast
) → Vector3,
GetAccelerationCast: (
Caster,
cast: vaildcast
) → Vector3,
SetAccelerationCast: (
Caster,
cast: vaildcast,
acceleration: Vector3
) → (),
GetPositionCast: (
Caster,
cast: vaildcast,
Position: Vector3
) → Vector3,
AddPositionCast: (
Caster,
cast: vaildcast,
Position: Vector3
) → (),
ResumeCast: (
Caster,
cast: vaildcast
) → (),
PauseCast: (
Caster,
cast: vaildcast
) → (),
SyncChangesToCast: (
Caster,
cast: vaildcast
) → (),
TerminateCast: (
Caster,
cast: vaildcast
) → (),
Destroy: (Caster) → ()
}

Represents a Caster.

VisualizeCastSettings​

</>
type VisualizeCastSettings = {
Debug_SegmentColor: Color3,
Debug_SegmentTransparency: number,
Debug_SegmentSize: number,
Debug_HitColor: Color3,
Debug_HitTransparency: number,
Debug_HitSize: number,
Debug_RayPierceColor: Color3,
Debug_RayPierceTransparency: number,
Debug_RayPierceSize: number,
Debug_RayLifetime: number,
Debug_HitLifetime: number
}

Debug visualization settings for casts.

AdaptivePerformance​

</>
type AdaptivePerformance = {
HighFidelitySegmentSizeIncrease: number,
LowerHighFidelityBehavior: boolean
}

Adaptive performance config used when AutomaticPerformance is enabled.

FastCastEventsModuleConfig​

</>
type FastCastEventsModuleConfig = {
UseLengthChanged: boolean,
UseHit: boolean,
UsePierced: boolean,
UseCastTerminating: boolean,
UseCanPierce: boolean,
UseCastFire: boolean
}

Represents a FastCastBehavior configuration.

FastCastEventsConfig​

</>
type FastCastEventsConfig = {
UseLengthChanged: boolean,
UseHit: boolean,
UsePierced: boolean,
UseCastTerminating: boolean,
UseCastFire: boolean
}

Represents a FastCastBehavior configuration.

FastCastBehavior​

</>
type FastCastBehavior = {
RaycastParams: RaycastParams?,
MaxDistance: number,
Acceleration: Vector3,
HighFidelityBehavior: number,
HighFidelitySegmentSize: number,
CosmeticBulletTemplate: Instance?,
CosmeticBulletContainer: Instance?,
AutoIgnoreContainer: boolean,
SimulateAfterPhysic: boolean,
AutomaticPerformance: boolean,
AdaptivePerformance: AdaptivePerformance,
VisualizeCasts: boolean,
VisualizeCastSettings: VisualizeCastSettings,
FastCastEventsModuleConfig: FastCastEventsModuleConfig,
FastCastEventsConfig: FastCastEventsConfig,
UserData: any
}

Represents a FastCastBehavior configuration.

CastTrajectory​

</>
type CastTrajectory = {
StartTime: number,
EndTime: number,
Origin: Vector3,
InitialVelocity: Vector3,
Acceleration: Vector3
}

Represents a cast trajectory segment.

CastStateInfo​

</>
type CastStateInfo = {
UpdateConnection: RBXScriptSignal,
HighFidelityBehavior: number,
HighFidelitySegmentSize: number,
Paused: boolean,
TotalRuntime: number,
DistanceCovered: number,
IsActivelySimulatingPierce: boolean,
IsActivelyResimulating: boolean,
CancelHighResCast: boolean,
Trajectories: {[number]: CastTrajectory},
VisualizeCasts: boolean,
VisualizeCastSettings: VisualizeCastSettings,
FastCastEventsConfig: FastCastEventsConfig,
FastCastEventsModuleConfig: FastCastEventsModuleConfig
}

Represents cast state tracking data.

CastRayInfo​

</>
type CastRayInfo = {
Parameters: RaycastParams,
WorldRoot: WorldRoot,
MaxDistance: number,
CosmeticBulletObject: Instance?,
CanPierceModule: ModuleScript?
}

Ray info for ray-cast variants.

BlockCastRayInfo​

</>
type BlockCastRayInfo = {
Parameters: RaycastParams,
WorldRoot: WorldRoot,
MaxDistance: number,
CosmeticBulletObject: Instance?,
CanPierceModule: ModuleScript?,
Size: Vector3
}

Ray info for block-cast variants.

SpherecastRayInfo​

</>
type SpherecastRayInfo = {
Parameters: RaycastParams,
WorldRoot: WorldRoot,
MaxDistance: number,
CosmeticBulletObject: Instance?,
CanPierceModule: ModuleScript?,
Radius: number
}

Ray info for sphere-cast variants.

BaseCastData​

</>
type BaseCastData = {
Output: BindableEvent,
ActiveCastCleaner: BindableEvent,
ObjectCache: BindableFunction?,
CacheHolder: any?,
SyncChange: BindableEvent
}

Data stored on the caster that ActiveCasts reference.

ActiveCastData​

</>
type ActiveCastData = {
Caster: BaseCastData,
StateInfo: CastStateInfo,
RayInfo: CastRayInfo,
UserData: {[any]: any},
Type: "Raycast",
CFrame: CFrame,
ID: number
}

Represents an active cast data.

ActiveCastData​

</>
type ActiveCastData = {
Caster: BaseCastData,
StateInfo: CastStateInfo,
RayInfo: CastRayInfo,
UserData: {[any]: any},
Type: "Blockcast",
CFrame: CFrame,
ID: number
}

Represents an active block cast data.

ActiveCastData​

</>
type ActiveCastData = {
Caster: BaseCastData,
StateInfo: CastStateInfo,
RayInfo: CastRayInfo,
UserData: {[any]: any},
Type: "Spherecast",
CFrame: CFrame,
ID: number
}

Represents an active sphere cast data.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "vaildcast",
            "desc": "A type that can be either an ActiveCast or an ActiveBlockcast.",
            "lua_type": "ActiveCastData | ActiveBlockcastData | ActiveSpherecastData",
            "source": {
                "line": 27,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "FastCastEventsModule",
            "desc": "A moduleScript that will be required by ActiveCast",
            "lua_type": "ModuleScript",
            "source": {
                "line": 35,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "FastCastEvents",
            "desc": "A table of callback functions (events/hooks) used by ActiveCast.\nThese functions are invoked by ActiveCast during a lifecycle (e.g., length updates, pierce checks).",
            "lua_type": "{ CanPierce: CanPierceFunction, Hit: OnHitFunction, Pierced: OnPiercedFunction, LengthChanged: OnLengthChangedFunction, CastTerminating: OnCastTerminatingFunction, CastFire: OnCastFireFunction }",
            "source": {
                "line": 44,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "CanPierceFunction",
            "desc": "Callback used to decide whether a cast should pierce and continue after a hit.",
            "lua_type": "(cast: vaildcast, result: RaycastResult, segmentVelocity: Vector3, cosmeticBulletObject: Instance?) -> boolean",
            "source": {
                "line": 59,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "OnHitFunction",
            "desc": "Callback fired when the cast hits something (non-piercing).",
            "lua_type": "(cast: vaildcast, result: RaycastResult, segmentVelocity: Vector3, cosmeticBulletObject: Instance?) -> ()",
            "source": {
                "line": 72,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "OnPierceFunction",
            "desc": "Callback fired when the cast pierces something.",
            "lua_type": "(cast: vaildcast, result: RaycastResult, segmentVelocity: Vector3, cosmeticBulletObject: Instance?) -> ()",
            "source": {
                "line": 85,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "OnLengthChangedFunction",
            "desc": "Callback fired when the cast's length changes as it updates.",
            "lua_type": "(cast: vaildcast, lastPoint: Vector3, rayDir: Vector3, rayDisplacement: number, segmentVelocity: Vector3, cosmeticBulletObject: Instance?) -> ()",
            "source": {
                "line": 98,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "OnCastTerminatingFunction",
            "desc": "Callback fired right as an ActiveCast is terminating.",
            "lua_type": "(cast: vaildcast) -> ()",
            "source": {
                "line": 113,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "OnCastFireFunction",
            "desc": "Callback fired when a cast is initially fired.",
            "lua_type": "(cast: vaildcast, lastPoint: Vector3, rayDir: Vector3, segmentVelocity: Vector3, behavior: FastCastBehavior) -> ()",
            "source": {
                "line": 121,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "ObjectCache",
            "desc": "Represents a ObjectCache object.",
            "lua_type": "{ GetPart: (ObjectCache, PartCFrame: CFrame) -> BasePart, ReturnPart: (ObjectCache, Part: BasePart) -> (), Update: (ObjectCache) -> (), ExpandCache: (ObjectCache, Amount: number) -> (), SetExpandAmount: (ObjectCache, Amount: number) -> (), IsInUse: (ObjectCache, Object: BasePart) -> boolean, Destroy: (ObjectCache) -> () }",
            "source": {
                "line": 135,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "Caster",
            "desc": "Represents a Caster.",
            "lua_type": "{ WorldRoot: WorldRoot, LengthChanged: Signal<OnLengthChangedFunction> | OnLengthChangedFunction, Hit: Signal<OnHitFunction> | OnHitFunction, Pierced: Signal<OnPiercedFunction> | OnPiercedFunction, CastTerminating: Signal<OnCastTerminatingFunction> | OnCastTerminatingFunction, CastFire: Signal<OnCastFireFunction> | OnCastFireFunction, Dispatcher: Dispatcher.Dispatcher, ObjectCache: ObjectCache, AlreadyInit: boolean, ObjectCacheEnabled: boolean, BulkMoveEnabled: boolean, FastCastEventsModule: FastCastEventsModule, Init: ( self: Caster, numWorkers: number, newParent: Folder, newName: string, ContainerParent: Folder, VMContainerName: string, VMname: string, useBulkMoveTo: boolean, FastCastEventsModule: ModuleScript, useObjectCache: boolean, Template: BasePart | Model, CacheSize: number, CacheHolder: Instance ) -> (), RaycastFire: ( Caster, Origin: Vector3, Direction: Vector3, Velocity: Vector3 | number, Behavior: FastCastBehavior ) -> (), BlockcastFire: ( self: Caster, Origin: Vector3, Size: Vector3, Direction: Vector3, Velocity: Vector3 | number, Behavior: FastCastBehavio ) -> (), SetBulkMoveEnabled: (self: Caster, enabled: boolean) -> (), SetObjectCacheEnabled: ( self: Caster, enabled: boolean, Template: BasePart | Model, CacheSize: number, CacheHolder: Instance ) -> (), SetFastCastEventsModule: (self: Caster, moduleScript: ModuleScript) -> (), AddVelocityCast: (Caster, cast: vaildcast, velocity: Vector3) -> (), SetVelocityCast: (Caster, cast: vaildcast, velocity: Vector3) -> (), GetVelocityCast: (Caster, cast: vaildcast, velocity: Vector3) -> Vector3, AddAccelerationCast: (Caster, cast: vaildcast) -> Vector3, GetAccelerationCast: (Caster, cast: vaildcast) -> Vector3, SetAccelerationCast: (Caster, cast: vaildcast, acceleration: Vector3) -> (), GetPositionCast: (Caster, cast: vaildcast, Position: Vector3) -> Vector3, AddPositionCast: (Caster, cast: vaildcast, Position: Vector3) -> (), ResumeCast: (Caster, cast: vaildcast) -> (), PauseCast: (Caster, cast: vaildcast) -> (), SyncChangesToCast: (Caster, cast: vaildcast) -> (), TerminateCast: (Caster, cast: vaildcast) -> (), Destroy: (Caster) -> () }",
            "source": {
                "line": 152,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "VisualizeCastSettings",
            "desc": "Debug visualization settings for casts.",
            "lua_type": "{ Debug_SegmentColor: Color3, Debug_SegmentTransparency: number, Debug_SegmentSize: number, Debug_HitColor: Color3, Debug_HitTransparency: number, Debug_HitSize: number, Debug_RayPierceColor: Color3, Debug_RayPierceTransparency: number, Debug_RayPierceSize: number, Debug_RayLifetime: number, Debug_HitLifetime: number }",
            "source": {
                "line": 246,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "AdaptivePerformance",
            "desc": "Adaptive performance config used when AutomaticPerformance is enabled.",
            "lua_type": "{ HighFidelitySegmentSizeIncrease: number, LowerHighFidelityBehavior: boolean }",
            "source": {
                "line": 269,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "FastCastEventsModuleConfig",
            "desc": "Represents a FastCastBehavior configuration.",
            "lua_type": "{ UseLengthChanged: boolean, UseHit: boolean, UsePierced: boolean, UseCastTerminating: boolean, UseCanPierce: boolean, UseCastFire: boolean }",
            "source": {
                "line": 280,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "FastCastEventsConfig",
            "desc": "Represents a FastCastBehavior configuration.",
            "lua_type": "{ UseLengthChanged: boolean, UseHit: boolean, UsePierced: boolean, UseCastTerminating: boolean, UseCastFire: boolean }",
            "source": {
                "line": 295,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "FastCastBehavior",
            "desc": "Represents a FastCastBehavior configuration.",
            "lua_type": "{ RaycastParams: RaycastParams?, MaxDistance: number, Acceleration: Vector3, HighFidelityBehavior: number, HighFidelitySegmentSize: number, CosmeticBulletTemplate: Instance?, CosmeticBulletContainer: Instance?, AutoIgnoreContainer: boolean, SimulateAfterPhysic: boolean, AutomaticPerformance: boolean, AdaptivePerformance: AdaptivePerformance, VisualizeCasts: boolean, VisualizeCastSettings: VisualizeCastSettings, FastCastEventsModuleConfig: FastCastEventsModuleConfig, FastCastEventsConfig: FastCastEventsConfig, UserData: any }",
            "source": {
                "line": 309,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "CastTrajectory",
            "desc": "Represents a cast trajectory segment.",
            "lua_type": "{ StartTime: number, EndTime: number, Origin: Vector3, InitialVelocity: Vector3, Acceleration: Vector3 }",
            "source": {
                "line": 339,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "CastStateInfo",
            "desc": "Represents cast state tracking data.",
            "lua_type": "{ UpdateConnection: RBXScriptSignal, HighFidelityBehavior: number, HighFidelitySegmentSize: number, Paused: boolean, TotalRuntime: number, DistanceCovered: number, IsActivelySimulatingPierce: boolean, IsActivelyResimulating: boolean, CancelHighResCast: boolean, Trajectories: { [number]: CastTrajectory }, VisualizeCasts: boolean, VisualizeCastSettings: VisualizeCastSettings, FastCastEventsConfig: FastCastEventsConfig, FastCastEventsModuleConfig: FastCastEventsModuleConfig }",
            "source": {
                "line": 353,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "CastRayInfo",
            "desc": "Ray info for ray-cast variants.",
            "lua_type": "{ Parameters: RaycastParams, WorldRoot: WorldRoot, MaxDistance: number, CosmeticBulletObject: Instance?, CanPierceModule: ModuleScript? }",
            "source": {
                "line": 378,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "BlockCastRayInfo",
            "desc": "Ray info for block-cast variants.",
            "lua_type": "{ Parameters: RaycastParams, WorldRoot: WorldRoot, MaxDistance: number, CosmeticBulletObject: Instance?, CanPierceModule: ModuleScript?, Size: Vector3 }",
            "source": {
                "line": 392,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "SpherecastRayInfo",
            "desc": "Ray info for sphere-cast variants.",
            "lua_type": "{ Parameters: RaycastParams, WorldRoot: WorldRoot, MaxDistance: number, CosmeticBulletObject: Instance?, CanPierceModule: ModuleScript?, Radius: number }",
            "source": {
                "line": 407,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "BaseCastData",
            "desc": "Data stored on the caster that ActiveCasts reference.",
            "lua_type": "{ Output: BindableEvent, ActiveCastCleaner: BindableEvent, ObjectCache: BindableFunction?, CacheHolder: any?, SyncChange : BindableEvent }",
            "source": {
                "line": 422,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "ActiveCastData",
            "desc": "Represents an active cast data.",
            "lua_type": "{Caster: BaseCastData,StateInfo: CastStateInfo,RayInfo: CastRayInfo,UserData: { [any]: any }, Type : \"Raycast\",CFrame: CFrame,ID: number}",
            "source": {
                "line": 438,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "ActiveCastData",
            "desc": "Represents an active block cast data.",
            "lua_type": "{ Caster: BaseCastData, StateInfo: CastStateInfo, RayInfo: CastRayInfo, UserData: { [any]: any }, Type : \"Blockcast\", CFrame: CFrame, ID: number }",
            "source": {
                "line": 455,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        },
        {
            "name": "ActiveCastData",
            "desc": "Represents an active sphere cast data.",
            "lua_type": "{ Caster: BaseCastData, StateInfo: CastStateInfo, RayInfo: CastRayInfo, UserData: { [any]: any }, Type : \"Spherecast\", CFrame: CFrame, ID: number }",
            "source": {
                "line": 472,
                "path": "src/FastCast2/TypeDefinitions.luau"
            }
        }
    ],
    "name": "TypeDefinitions",
    "desc": "Type definitions for strict-typing.",
    "tags": [
        "Types"
    ],
    "source": {
        "line": 15,
        "path": "src/FastCast2/TypeDefinitions.luau"
    }
}