BranchedBolt 
A lightning bolt drawn between two vectors with 3 to 6 branched lightning bolts
Procs | |
| Create | Initializes the branched lightning bolts list the first bolt in the list will be the main bolt between the two given vectors with the addition of 3 to 6 branched bolts |
|---|---|
| Draw | Draws a branched lightning bolt of type with a color between two assigned vectors on z or client screen |
| GetAllTurfs | Returns a list of turfs between the bolt's starting vector to the bolt's end vector checking all segments including all branched bolts It can return null if no turfs are found. |
| GetTurfs | Returns a list of turfs between the bolt's starting vector to the bolt's end vector without including branched bolts because this only checks first and last vectors it returns a form of line between both vectors and can be inaccurate if bolt segments stray too far It can return null if no turfs are found. |
| New | Constructs the branched bolt, from vector source to vector dest |
Proc Details
Create
Initializes the branched lightning bolts list the first bolt in the list will be the main bolt between the two given vectors with the addition of 3 to 6 branched bolts
- @param source source vector, where the bolt starts
- @param dest destination vector, where the bolt ends
Draw
Draws a branched lightning bolt of type with a color between two assigned vectors on z or client screen
- @param z the map z level to draw on, if z is client it will draw on client screen
- @param type basic segment to use when drawing
- @param color color of the branched bolt
- @param thickness thickness of the branched bolt
- @param split if set to 1 will create an obj for each segment, if not it will only create one object with segments as overlays
GetAllTurfs
Returns a list of turfs between the bolt's starting vector to the bolt's end vector checking all segments including all branched bolts It can return null if no turfs are found.
- @param z the map z level to search
- @param accurate controlls the accurecy of this function, lower number means more accurate results however it reduces performance 1 being the minimum @return a list of turfs the bolts pass on
GetTurfs
Returns a list of turfs between the bolt's starting vector to the bolt's end vector without including branched bolts because this only checks first and last vectors it returns a form of line between both vectors and can be inaccurate if bolt segments stray too far It can return null if no turfs are found.
- @param z the map z level to search
- @param accurate controlls the accurecy of this function, lower number means more accurate results however it reduces performance 1 being the minimum, it should be noted even at 1 this will not be too accurate, use GetAllTurfs() for a more accurate result @return a partial list of turfs the main bolt passes on
New
Constructs the branched bolt, from vector source to vector dest
- @param source source vector, where the bolt starts
- @param dest destination vector, where the bold ends
- @param fade assigns fade out rate, default of 50