{"id":2199,"date":"2022-09-19T11:46:47","date_gmt":"2022-09-19T11:46:47","guid":{"rendered":"https:\/\/3dcoat.com\/documentation\/?post_type=manual_documentation&#038;p=2199"},"modified":"2023-10-29T21:37:24","modified_gmt":"2023-10-29T21:37:24","slug":"scripting","status":"publish","type":"manual_documentation","link":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/scripting\/","title":{"rendered":"Scripting"},"content":{"rendered":"\n<h4 class=\"wp-block-heading\" id=\"menu_script_commands\">Menu Script commands:<a href=\"https:\/\/3dcoat.com\/dokuwiki\/doku.php?id=general:interface_navigation:scripts_menu#menu_script_commands\"><\/a><\/h4>\n\n\n\n<p><strong>Run Script:<\/strong>&nbsp;Execute Script.<br \/>Create Your Script:<br \/>Create new Core&nbsp;API&nbsp;Script: The core API script is a compliable C++17 program that works on the full native C++ speed. This is far more than just a script; you may make even time-critical and multithreaded tasks and customize the 3DCoat in-depth, creating principally new functionality and tools.<br \/><strong>The Core&nbsp;<abbr title=\"\">API<\/abbr>&nbsp;documentation:<\/strong>&nbsp; Core&nbsp;API&nbsp;script is a compliable C++17 program that works on the full native C++ speed. This is far more than just a script; you may make even time-critical and multithreaded tasks and customize the 3DCoat in-depth, creating principally new functionality and tools.<br \/>Scripting Manual:&nbsp;information on how to write Scripts.<br \/>View Execution Log:&nbsp;Open the execution log in an external text editor. The log is placed in the user documents folder&nbsp;\\\\3DCoat\\UserPrefs\\Scripts\\log.txt<br \/>Start Record Script: Recording Script in an external text file. The file is placed in the user documents 3DCoat installation folder UserPrefs\/Scripts and will write to the script history after running.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<pre class=\"wp-block-preformatted\">RMB over the script in the Script menu allows to create the 3dcpack to distribute your script<\/pre>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full\"><img decoding=\"async\" width=\"288\" height=\"127\" src=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg\" alt=\"\" class=\"wp-image-4763\"\/><figcaption class=\"wp-element-caption\">Scripts<\/figcaption><\/figure>\n<\/div>\n\n\n<p><a href=\"https:\/\/youtu.be\/I2u7fH1ipBo?list=UUz7E0meXd2yMj4TKY2h0Rbg\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">UnGhost All Script<\/a>: The Script is directly downloadable&nbsp;<a href=\"https:\/\/3dcoat.com\/forum\/index.php?\/topic\/16302-script-ajz_visibilitygroups\/\">from this link<\/a>.<\/p>\n\n\n\n<p>To install it, simply copy the \u201cunghost.txt\u201d and \u201cunghost.xml\u201d files to the following directory:<br \/><strong>&#8220;\\3DCoat\\UserPrefs\\Scripts\\ExtraMenuItems\\&#8221;<\/strong><\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p>the&nbsp;path in the .xml&nbsp;Command tag should&nbsp;be relative to the&nbsp;3dc Prefs folder.&nbsp;In V4 it&#8217;s<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">&lt;Command&gt;script:Scripts\/ExtraMenuItems\/scriptName.txt&lt;\/Command&gt;<\/pre>\n\n\n\n<p>and in 2022 the prefs were moved deeper:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">&lt;Command&gt;script:UserPrefs\/Scripts\/ExtraMenuItems\/scriptName.txt&lt;\/Command&gt;<\/pre>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"scripting_manual_and_documents\">Scripting Manual and documents<a href=\"https:\/\/3dcoat.com\/dokuwiki\/doku.php?id=general:interface_navigation:scripts_menu#scripting_manual_and_documents\"><\/a><\/h3>\n\n\n\n<p>3DC uses Angelscript as a programming language.<br \/>Here you can find the online manual:<\/p>\n\n\n\n<div class=\"wp-block-buttons is-layout-flex wp-block-buttons-is-layout-flex\">\n<div class=\"wp-block-button aligncenter\"><a class=\"wp-block-button__link wp-element-button\" href=\"https:\/\/pilgway.com\/files\/scriptdocs\/\" target=\"_blank\" rel=\"noreferrer noopener\">3DCoat Scripting manual<\/a><\/div>\n<\/div>\n\n\n\n<p>Manual .pdf can be found inside the default installation folder <em>C:\\Program Files\\3DCoat-2022\\UserPrefs\\Scripts<\/em><\/p>\n\n\n\n<div class=\"wp-block-file\"><a id=\"wp-block-file--media-130aff87-9ded-4eb8-9850-6d642531bdf1\" href=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/11\/Scripting.pdf\" target=\"_blank\" rel=\"noreferrer noopener\"><strong>Scripting manual .pdf format<\/strong><\/a><a href=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/11\/Scripting.pdf\" class=\"wp-block-file__button wp-element-button\" download aria-describedby=\"wp-block-file--media-130aff87-9ded-4eb8-9850-6d642531bdf1\"><\/a><\/div>\n\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"scripting_primitives_and_classes\">Scripting Primitives and Classes<a href=\"https:\/\/3dcoat.com\/dokuwiki\/doku.php?id=general:interface_navigation:scripts_menu#scripting_primitives_and_classes\"><\/a><\/h2>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full\"><img decoding=\"async\" width=\"700\" height=\"431\" src=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/primitivestoolscriptrecording.jpeg\" alt=\"\" class=\"wp-image-3412\" srcset=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/primitivestoolscriptrecording.jpeg 700w, https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/primitivestoolscriptrecording-300x185.jpeg 300w\" sizes=\"(max-width: 700px) 100vw, 700px\" \/><\/figure>\n<\/div>\n\n\n<p><strong>Added a Script command generator in the primitive tool, Sculpt, and Retopo rooms:<\/strong>&nbsp;You can save your actions in a script file, change your primitive parameters in the script and run it again.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full\"><img decoding=\"async\" width=\"700\" height=\"515\" src=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/newscriptclassesformodelingretopoprimitives.jpeg\" alt=\"\" class=\"wp-image-3413\" srcset=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/newscriptclassesformodelingretopoprimitives.jpeg 700w, https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/10\/newscriptclassesformodelingretopoprimitives-300x221.jpeg 300w\" sizes=\"(max-width: 700px) 100vw, 700px\" \/><\/figure>\n<\/div>\n\n\n<p><strong>New Script Classes for Modeling\/Retopo Primitives:<\/strong>&nbsp;Added the support of Modeling\/Retopo primitives via Scripts. You can create Modeling\/Retopo primitives using the script interface, control primitive parameters, and add and delete the primitives from the Retopo scene.<\/p>\n\n\n\n<p><strong>Added the Record Script button in the top menu:<\/strong>&nbsp;The button changes the color depending on the record state. If the button is red, the script is recording; the blue button indicates that the recording is stopped.<\/p>\n\n\n\n<p><strong>Access to live booleans via the python\/CoreAPI.<\/strong><\/p>\n\n\n\n<p><a href=\"https:\/\/youtu.be\/59BE8wOaKPY\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Record Script in Retopo Primitives 1<\/a><br \/><a href=\"https:\/\/youtu.be\/K1JfqB6ynN8\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Record Script in Retopo Primitives 2<\/a><\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"scripts_example\">Scripts example<a href=\"https:\/\/3dcoat.com\/dokuwiki\/doku.php?id=general:interface_navigation:scripts_menu#scripts_example\"><\/a><\/h3>\n\n\n\n<p><strong><a href=\"https:\/\/youtu.be\/CQWd8npvEMs\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Batch Layer Renaming Script<\/a>:<\/strong>&nbsp;By Anton Tenitsky.<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":2379,"menu_order":1,"template":"","manualdocumentationcategory":[9],"manual_doc_tag":[],"class_list":["post-2199","manual_documentation","type-manual_documentation","status-publish","hentry","manualdocumentationcategory-manual"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.3 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Scripting - 3DCoat Documentation<\/title>\n<meta name=\"description\" content=\"A brief explanation of the basic principles of use in the Scripting. And the link to the main section of the Scripting documentation\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/scripting\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Scripting - 3DCoat Documentation\" \/>\n<meta property=\"og:description\" content=\"A brief explanation of the basic principles of use in the Scripting. And the link to the main section of the Scripting documentation\" \/>\n<meta property=\"og:url\" content=\"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/scripting\/\" \/>\n<meta property=\"og:site_name\" content=\"3DCoat Documentation\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/3DCoat\" \/>\n<meta property=\"article:modified_time\" content=\"2023-10-29T21:37:24+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@3DCoatOfficial\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/\",\"url\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/\",\"name\":\"Scripting - 3DCoat Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg\",\"datePublished\":\"2022-09-19T11:46:47+00:00\",\"dateModified\":\"2023-10-29T21:37:24+00:00\",\"description\":\"A Scripting haszn\u00e1lati alapelveinek r\u00f6vid magyar\u00e1zata. \u00c9s a hivatkoz\u00e1s a Scripting dokument\u00e1ci\u00f3 f\u0151 r\u00e9sz\u00e9hez\",\"breadcrumb\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage\",\"url\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg?wsr\",\"contentUrl\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg?wsr\",\"width\":288,\"height\":127},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/3dcoat.com\/documentation\/nl_NL\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Scripting & Core API\",\"item\":\"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Scripting\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#website\",\"url\":\"https:\/\/3dcoat.com\/documentation\/\",\"name\":\"3DCoat Documentation\",\"description\":\"Information about starting to use and learning how to use all the features of the 3DCoat.\",\"publisher\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/3dcoat.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#organization\",\"name\":\"Pilgway\",\"url\":\"https:\/\/3dcoat.com\/documentation\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png\",\"contentUrl\":\"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png\",\"width\":876,\"height\":190,\"caption\":\"Pilgway\"},\"image\":{\"@id\":\"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/3DCoat\",\"https:\/\/x.com\/3DCoatOfficial\",\"https:\/\/www.youtube.com\/c\/PILGWAY3DCoat\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Scripting - 3DCoat Documentation","description":"A brief explanation of the basic principles of use in the Scripting. And the link to the main section of the Scripting documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/scripting\/","og_locale":"en_US","og_type":"article","og_title":"Scripting - 3DCoat Documentation","og_description":"A brief explanation of the basic principles of use in the Scripting. And the link to the main section of the Scripting documentation","og_url":"https:\/\/3dcoat.com\/documentation\/manual\/scripting-and-core-api\/scripting\/","og_site_name":"3DCoat Documentation","article_publisher":"https:\/\/www.facebook.com\/3DCoat","article_modified_time":"2023-10-29T21:37:24+00:00","og_image":[{"url":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg","type":"","width":"","height":""}],"twitter_card":"summary_large_image","twitter_site":"@3DCoatOfficial","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/","url":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/","name":"Scripting - 3DCoat Documentation","isPartOf":{"@id":"https:\/\/3dcoat.com\/documentation\/#website"},"primaryImageOfPage":{"@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage"},"image":{"@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage"},"thumbnailUrl":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg","datePublished":"2022-09-19T11:46:47+00:00","dateModified":"2023-10-29T21:37:24+00:00","description":"A Scripting haszn\u00e1lati alapelveinek r\u00f6vid magyar\u00e1zata. \u00c9s a hivatkoz\u00e1s a Scripting dokument\u00e1ci\u00f3 f\u0151 r\u00e9sz\u00e9hez","breadcrumb":{"@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#primaryimage","url":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg?wsr","contentUrl":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2023\/01\/Scripts_RMB.jpg?wsr","width":288,"height":127},{"@type":"BreadcrumbList","@id":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/scripting\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/3dcoat.com\/documentation\/nl_NL\/"},{"@type":"ListItem","position":2,"name":"Scripting & Core API","item":"https:\/\/3dcoat.com\/documentation\/hu_HU\/manual\/scripting-and-core-api\/"},{"@type":"ListItem","position":3,"name":"Scripting"}]},{"@type":"WebSite","@id":"https:\/\/3dcoat.com\/documentation\/#website","url":"https:\/\/3dcoat.com\/documentation\/","name":"3DCoat Documentation","description":"Information about starting to use and learning how to use all the features of the 3DCoat.","publisher":{"@id":"https:\/\/3dcoat.com\/documentation\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/3dcoat.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/3dcoat.com\/documentation\/#organization","name":"Pilgway","url":"https:\/\/3dcoat.com\/documentation\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/","url":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png","contentUrl":"https:\/\/3dcoat.com\/documentation\/wp-content\/uploads\/2022\/09\/logo3DCoatWhite-1.png","width":876,"height":190,"caption":"Pilgway"},"image":{"@id":"https:\/\/3dcoat.com\/documentation\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/3DCoat","https:\/\/x.com\/3DCoatOfficial","https:\/\/www.youtube.com\/c\/PILGWAY3DCoat"]}]}},"_links":{"self":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2199","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":27,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2199\/revisions"}],"predecessor-version":[{"id":7131,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2199\/revisions\/7131"}],"up":[{"embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_documentation\/2379"}],"wp:attachment":[{"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/media?parent=2199"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manualdocumentationcategory?post=2199"},{"taxonomy":"manual_doc_tag","embeddable":true,"href":"https:\/\/3dcoat.com\/documentation\/wp-json\/wp\/v2\/manual_doc_tag?post=2199"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}