Skip to main content

Project

Module for getting projects and validation of the project spec Projects are assumed to be in a Folder named "RideData" in ReplicatedStorage

Functions​

getProject​

</>
Project.getProject(name: string) → Result<Instance,string>

Return the project data with the given name. Assumes data is located in a Folder in ReplicatedStorage named RideData.

Show raw api
{
    "functions": [
        {
            "name": "getProject",
            "desc": "Return the project data with the given name.\nAssumes data is located in a Folder in ReplicatedStorage named RideData.",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<Instance, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/shared/project/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Project",
    "desc": "Module for getting projects and validation of the project spec\nProjects are assumed to be in a Folder named \"RideData\" in ReplicatedStorage",
    "source": {
        "line": 8,
        "path": "src/shared/project/init.lua"
    }
}