ActiveBlockCast
An ActiveBlockCast represents a BlockCast fired by a parent Caster. It contains methods of accessing the physics data of this specific BlockCast at any given time, as well as methods to alter its trajectory during runtime.
Show raw api
{
"functions": [
{
"name": "new",
"desc": "Creates a new ActiveBlockCast instance with the given parameters.\nThis is the fancy part where numbers and vectors start cooperating.",
"params": [
{
"name": "BaseCast",
"desc": "The base cast data used to initialize the active cast.",
"lua_type": "TypeDef.BaseCastData"
},
{
"name": "activeCastID",
"desc": "Unique identifier for this active cast.",
"lua_type": "string"
},
{
"name": "origin",
"desc": "The starting position of the cast.",
"lua_type": "Vector3"
},
{
"name": "size",
"desc": "The size of the cast volume.",
"lua_type": "Vector3"
},
{
"name": "direction",
"desc": "The direction the cast will travel in.",
"lua_type": "Vector3"
},
{
"name": "velocity",
"desc": "The velocity of the cast (either directional or scalar).",
"lua_type": "Vector3 | number"
},
{
"name": "eventModule",
"desc": "The event module to use for this cast.",
"lua_type": "TypeDef.FastCastEventsModule"
}
],
"returns": [
{
"desc": "The newly created ActiveBlockcastCompement.",
"lua_type": "ActiveBlockcastCompement"
}
],
"function_type": "static",
"private": true,
"source": {
"line": 691,
"path": "src/FastCast2/ActiveBlockcast.luau"
}
}
],
"properties": [],
"types": [],
"name": "ActiveBlockCast",
"desc": "An ActiveBlockCast represents a BlockCast fired by a parent [Caster](Caster). It contains methods of accessing the physics \ndata of this specific BlockCast at any given time, as well as methods to alter its trajectory during runtime.",
"source": {
"line": 47,
"path": "src/FastCast2/ActiveBlockcast.luau"
}
}