Skip to main content

MinEntranceVelocityUtils

Class of functions that can be used to minimize entrance velocity of a projectile.

Functions

minimizeEntranceVelocity

MinEntranceVelocityUtils.minimizeEntranceVelocity(
originVector3,
targetVector3,
accelVector3
) → number

Determines the starting velocity to minimize the velocity at the target for a parabula

computeEntranceVelocity

MinEntranceVelocityUtils.computeEntranceVelocity(
velocityVector3,
originVector3,
targetVector3,
accelVector3
) → Vector3

Computes the velocity the target will enter the target

note

This may only works for a minimizeEntranceVelocity

computeEntranceTime

MinEntranceVelocityUtils.computeEntranceTime(
velocityVector3,
originVector3,
targetVector3,
accelVector3
) → number

Computes the time stamp the project enters the target

note

This may only works for a minimizeEntranceVelocity

Show raw api
{
    "functions": [
        {
            "name": "minimizeEntranceVelocity",
            "desc": "Determines the starting velocity to minimize the velocity at the target for a parabula",
            "params": [
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "accel",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/trajectory/src/Shared/MinEntranceVelocityUtils.lua"
            }
        },
        {
            "name": "computeEntranceVelocity",
            "desc": "Computes the velocity the target will enter the target\n\n:::note\nThis may only works for a minimizeEntranceVelocity\n:::",
            "params": [
                {
                    "name": "velocity",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "accel",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/trajectory/src/Shared/MinEntranceVelocityUtils.lua"
            }
        },
        {
            "name": "computeEntranceTime",
            "desc": "Computes the time stamp the project enters the target\n\n:::note\nThis may only works for a minimizeEntranceVelocity\n:::",
            "params": [
                {
                    "name": "velocity",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "accel",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/trajectory/src/Shared/MinEntranceVelocityUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MinEntranceVelocityUtils",
    "desc": "Class of functions that can be used to minimize entrance velocity of a projectile.",
    "source": {
        "line": 5,
        "path": "src/trajectory/src/Shared/MinEntranceVelocityUtils.lua"
    }
}