VCORE Ecosystem StudioFrameworkServerClipr
VCORE Studio›Products›Vcore Framework›Resources
DocsResourcesAPIVCORE Server
Vcore Framework / Developer DocumentationDocumentation
Docs/Resources/Base/speedlimiter
Base Resource

Vcore-speedlimiter

Applies model, vehicle-class or default speed caps to the vehicle currently owned by the local driver. Values are configured in either mph or km/h and aircraft are exempt by default. The resource also owns the effective cap used by the mechanic M-key personal limiter. A personal limit can only lower the configured global cap; disabling it restores the configured cap rather than bypassing it. Current limit data is exposed through the vcoreSpeedLimit player state bag.

Resource folder: speedlimiterv1.0.0VCore FrameworkGameplay systems

Introduction

Applies model, vehicle-class or default speed caps to the vehicle currently owned by the local driver. Values are configured in either mph or km/h and aircraft are exempt by default. The resource also owns the effective cap used by the mechanic M-key personal limiter. A personal limit can only lower the configured global cap; disabling it restores the configured cap rather than bypassing it. Current limit data is exposed through the vcoreSpeedLimit player state bag.

1Client Lua
0Server Lua
7Exports
1Events
0SQL tables

No manifest UI page detected.

Dependencies & References

ResourceTypePackage status
coreManifest dependencyIncluded in Base

Cross-resource export calls

ResourceFunctions called
coregetCoreObject

Installation / Start Order

Install the resource with its required dependencies, then enable it in your resource start order.

server.cfg
ensure speedlimiter

Configuration

Config files

  • config.lua

Top-level config keys

ClassLimitsDebugDefaultLimitIdleIntervalMinimumDriverLimitModelLimitsRefreshIntervalShowDriverLimitNotificationsUnitUseClassLimits

Events, Exports & Callbacks

Exports

Client exports7
  • ApplyLimit
  • ClearDriverLimit
  • GetConfiguredDisplayLimit
  • GetConfiguredLimit
  • GetEffectiveLimit
  • IsDriverLimitActive
  • SetDriverLimit

Callbacks

No Vcore callbacks are documented for this resource.

Registered network events

Client registered events1
  • speedlimiter:client:refresh

Commands

No commands were detected.

Database / SQL

This resource does not include a resource-local SQL file.

This resource does not define its own CREATE TABLE statements.

Vcore also includes the consolidated VCORE_INSTALL.sql.

Source Layout

AreaFiles
Client Lua1
Server Lua0
Other/shared Lua2
JavaScript0
HTML0
CSS0
SQL0

Troubleshooting

  • Confirm all manifest dependencies are started before speedlimiter.
  • Confirm the resource is enabled in the correct start order.
  • If database queries fail, import the consolidated Base SQL and any resource-local SQL listed above.
  • If the UI fails, verify the resource's NUI files and ui_page when one is declared.