Skip to main content

ComponentService

ComponentService will automatically require any modules that are suffixed with "Component" and are descendants of the Orion.Client, Orion.Server, or Orion.Shared folders.

Functions​

GetComponentModule​

</>
ComponentService:GetComponentModule(
moduleName: string--

The name of the component module to get.

) → table--

The component module.

Gets a component module by name if it has been registered.

Show raw api
{
    "functions": [
        {
            "name": "GetComponentModule",
            "desc": "Gets a component module by name if it has been registered.",
            "params": [
                {
                    "name": "moduleName",
                    "desc": "The name of the component module to get.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "The component module.",
                    "lua_type": "table"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 50,
                "path": "src/componentservice/src/ComponentService.lua"
            }
        },
        {
            "name": "BlacklistName",
            "desc": "This method is intended to be called prior to RoamStart.\nIt will blacklist a name from being imported.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 59,
                "path": "src/componentservice/src/ComponentService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ComponentService",
    "desc": "ComponentService will automatically require any modules that are suffixed with \"Component\" and are descendants of the Orion.Client, Orion.Server, or Orion.Shared folders.",
    "source": {
        "line": 8,
        "path": "src/componentservice/src/ComponentService.lua"
    }
}