this script allows you to set up premade animations to use in your scripts
Client side
Initiate the animations export
local Animations = exports.vorp_animations.initiate()
Play Animation
Animations.playAnimation('campfire', 2000)
Stop Animation
Animations.endAnimation('campfire')
Start Animation indefinitely
Animations.startAnimation('campfire')
to activate in game , set in config to devmode true and use the command /startanimation campfire , the ui will allow you to adjust the animation so you can add them to config files
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"VORP Core","colors":{"primary":"#0D9773","light":"#eb6426","dark":"#0D9373"},"favicon":"https://mintcdn.com/vorpcore/XUhGBEjC0QCjR1XG/vorp.svg?fit=max\u0026auto=format\u0026n=XUhGBEjC0QCjR1XG\u0026q=85\u0026s=146b74a267a8e310a5fa47ad1fcb1b78","logo":{"light":"https://mintcdn.com/vorpcore/TmY6ok1sxwo6Xm_9/logo/64416274.png?fit=max\u0026auto=format\u0026n=TmY6ok1sxwo6Xm_9\u0026q=85\u0026s=2f8c116b6f3e772e3801f36c0eb6e086","dark":"https://mintcdn.com/vorpcore/TmY6ok1sxwo6Xm_9/logo/64416274.png?fit=max\u0026auto=format\u0026n=TmY6ok1sxwo6Xm_9\u0026q=85\u0026s=2f8c116b6f3e772e3801f36c0eb6e086"},"appearance":{"default":"dark","strict":false},"background":{"decoration":"windows"},"navbar":{"primary":{"type":"button","label":"txAdmin Installation","href":"https://docs.fivem.net/docs/server-manual/setting-up-a-server-txadmin/"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"RDR3 Natives","href":"https://rdr3natives.com","icon":"slack"},{"anchor":"RDR3 Discoveries","href":"https://github.com/femga/rdr3_discoveries","icon":"github"},{"anchor":"RDR3 Decompiled Scripts","href":"https://github.com/outsider31000/rdr2-scripts-decompiled","icon":"github"},{"anchor":"RDR3 Native Flags and Enums","href":"https://github.com/Halen84/RDR3-Native-Flags-And-Enums","icon":"slack"},{"anchor":"CFX.re Documentation","href":"https://docs.fivem.net/docs/","icon":"github"},{"anchor":"CFX Artifacts","href":"https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/","icon":"stack-overflow"},{"anchor":"LUA Documentation","href":"https://www.lua.org/docs.html","icon":"books"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vorpcore","hasAudioNarration":false,"actualSubdomain":"vorpcore","customDomains":["docs.vorp-core.com"],"gitSource":{"type":"github","owner":"vorpcore","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a37123c036a4121277a1365","collectionId":"a924fd8d-3e01-4c7c-928c-362cd786d063","schemaVersion":"v3"},"entitlements":{},"buildId":"6a37123c036a4121277a1365:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":9},{"language":"default","tag":"API Documentation","count":9},{"language":"default","tag":"Documentation","count":4},{"language":"default","tag":"Get Started","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/animations","slug":"/api-reference/animations","pageMetadata":{"title":"animations","description":"this script allows you to set up premade animations to use in your scripts","icon":"code","href":"/api-reference/animations"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"this script allows you to set up premade animations to use in your scripts\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:`Client side`}),`\n`,_jsx(_components.p,{children:`Initiate the animations export`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`lua`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`lua`,children:_jsxs(_components.code,{language:`lua`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`local`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` Animations`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` exports`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`vorp_animations`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`initiate`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Play Animation`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`lua`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`lua`,children:_jsxs(_components.code,{language:`lua`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Animations`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`playAnimation`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'campfire'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Stop Animation`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`lua`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`lua`,children:_jsxs(_components.code,{language:`lua`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Animations`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`endAnimation`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'campfire'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Start Animation indefinitely`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`lua`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`lua`,children:_jsxs(_components.code,{language:`lua`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Animations`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`startAnimation`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'campfire'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`to activate in game , set in config to `,_jsx(_components.code,{children:`devmode true`}),` and use the command `,_jsx(_components.code,{children:`/startanimation campfire`}),` , the ui will allow you to adjust the animation so you can add them to config files`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"animations","description":"this script allows you to set up premade animations to use in your scripts","icon":"code","href":"/api-reference/animations"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"vorpcore","siteName":"VORP Core","title":"animations - VORP Core","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T23:20:25.569Z","originalFileLocation":"api-reference/animations.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"this script allows you to set up premade animations to use in your scripts\">\u003cmeta data-mint-head name=\"application-name\" content=\"VORP Core\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"animations - VORP Core\">\u003cmeta data-mint-head property=\"og:description\" content=\"this script allows you to set up premade animations to use in your scripts\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VORP Core\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vorp-core.com/api-reference/animations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vorpcore.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=animations\u0026amp;description=this+script+allows+you+to+set+up+premade+animations+to+use+in+your+scripts\u0026amp;theme=c0705e914e64e496c3a27eeb\u0026amp;signature=c1fb29459e480d7260288da1a5f2d09952edb45b446a9096378787d792d780fd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"animations - VORP Core\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"this script allows you to set up premade animations to use in your scripts\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vorpcore.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=animations\u0026amp;description=this+script+allows+you+to+set+up+premade+animations+to+use+in+your+scripts\u0026amp;theme=c0705e914e64e496c3a27eeb\u0026amp;signature=c1fb29459e480d7260288da1a5f2d09952edb45b446a9096378787d792d780fd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vorpcore/g5TKKd1YOU0usdCM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VORP Core\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9773\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vorp-core.com/api-reference/animations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/animations.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vorp-core.com/#organization\",\"name\":\"VORP Core\",\"url\":\"https://docs.vorp-core.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vorpcore/TmY6ok1sxwo6Xm_9/logo/64416274.png?fit=max\u0026auto=format\u0026n=TmY6ok1sxwo6Xm_9\u0026q=85\u0026s=2f8c116b6f3e772e3801f36c0eb6e086\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vorp-core.com#website\",\"name\":\"VORP Core\",\"url\":\"https://docs.vorp-core.com\",\"publisher\":{\"@id\":\"https://docs.vorp-core.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vorp-core.com/api-reference/animations#webpage\",\"url\":\"https://docs.vorp-core.com/api-reference/animations\",\"name\":\"animations\",\"description\":\"this script allows you to set up premade animations to use in your scripts\",\"dateModified\":\"2026-01-22T23:20:25.569Z\",\"isPartOf\":{\"@id\":\"https://docs.vorp-core.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vorp-core.com/api-reference/animations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vorp-core.com/api-reference/animations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.vorp-core.com/api-reference/inventory\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"animations\",\"item\":\"https://docs.vorp-core.com/api-reference/animations\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vorp-core.com/api-reference/animations#article\",\"headline\":\"animations\",\"name\":\"animations\",\"description\":\"this script allows you to set up premade animations to use in your scripts\",\"url\":\"https://docs.vorp-core.com/api-reference/animations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vorp-core.com/api-reference/animations#webpage\"},\"dateModified\":\"2026-01-22T23:20:25.569Z\",\"publisher\":{\"@id\":\"https://docs.vorp-core.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vorp-core.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VORP Core\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VORP Core","nav":{"global":{"anchors":[{"anchor":"RDR3 Natives","href":"https://rdr3natives.com","icon":"slack"},{"anchor":"RDR3 Discoveries","href":"https://github.com/femga/rdr3_discoveries","icon":"github"},{"anchor":"RDR3 Decompiled Scripts","href":"https://github.com/outsider31000/rdr2-scripts-decompiled","icon":"github"},{"anchor":"RDR3 Native Flags and Enums","href":"https://github.com/Halen84/RDR3-Native-Flags-And-Enums","icon":"slack"},{"anchor":"CFX.re Documentation","href":"https://docs.fivem.net/docs/","icon":"github"},{"anchor":"CFX Artifacts","href":"https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/","icon":"stack-overflow"},{"anchor":"LUA Documentation","href":"https://www.lua.org/docs.html","icon":"books"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"inventory","icon":"code","href":"/api-reference/inventory"},{"title":"core","icon":"code","href":"/api-reference/core"},{"title":"character","icon":"code","href":"/api-reference/characters"},{"title":"menu","icon":"code","href":"/api-reference/menu"},{"title":"inputs","icon":"code","href":"/api-reference/inputs"},{"title":"progressbar","icon":"spinner","href":"/api-reference/progressbar"},{"title":"metabolism","description":"metabolism api for vorp","icon":"droplet","href":"/api-reference/metabolism"},{"title":"animations","icon":"code","href":"/api-reference/animations"},{"title":"lib","description":"VORP Lib is a modular scripting library for RedM that simplifies game development by providing reusable, instance-based components with automatic cleanup. Designed specifically for VORP Core Framework, it helps developers write cleaner, more efficient scripts while eliminating common issues like memory leaks and global variable pollution","icon":"code","href":"/api-reference/lib"}]}]}]},"title":"animations - VORP Core","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}