{"id":894,"date":"2025-03-12T15:39:18","date_gmt":"2025-03-12T15:39:18","guid":{"rendered":"https:\/\/www.portalsunited.com:443\/?post_type=docs&p=894"},"modified":"2025-03-13T13:24:29","modified_gmt":"2025-03-13T13:24:29","password":"","slug":"worldbuilder-runtime-scripting-documentation","status":"publish","type":"docs","link":"https:\/\/www.portalsunited.com:443\/docs\/worldbuilder-runtime-scripting-documentation\/","title":{"rendered":"World Builder – Runtime Scripting Documentation"},"content":{"rendered":"\n

Introduction to Runtime Scripting<\/h2>\n\n\n\n

WorldBuilder’s runtime scripting system enables the creation of custom interactive components directly within the application environment using C# programming language.<\/p>\n\n\n\n

Technical Framework<\/h2>\n\n\n\n

The runtime scripting implementation in WorldBuilder utilizes C# and the Unity engine’s core functionality. Components are created following a structured inheritance pattern:<\/p>\n\n\n\n

    \n
  1. Each component inherits from DataComponentBase<\/code><\/li>\n\n\n\n
  2. Properties are serialized using Newtonsoft.Json’s [JsonProperty]<\/code> attributes<\/li>\n\n\n\n
  3. Components leverage Unity’s lifecycle methods (Start()<\/code>, Update()<\/code>)<\/li>\n\n\n\n
  4. Inspector views are created separately to manage the component’s visual editing interface<\/li>\n<\/ol>\n\n\n\n

    Component Structure<\/h2>\n\n\n\n

    A runtime component consists of two primary files:<\/p>\n\n\n\n

      \n
    1. Component Implementation File<\/strong>: Defines behavior using C# and Unity libraries<\/li>\n\n\n\n
    2. Inspector View File<\/strong>: Provides the interface for modifying component properties<\/li>\n<\/ol>\n\n\n\n

      Component Implementation Example<\/h3>\n\n\n\n
      public<\/span> class<\/span> MyHoverComponent<\/span>: DataComponentBase<\/span>\n{\n    [JsonProperty(\"Speed\"<\/span>)]\n    public<\/span> float<\/span> Speed = 1.0<\/span>f;\n\n    [JsonProperty(\"Height\"<\/span>)]\n    public<\/span> float<\/span> Height = 2.0<\/span>f;\n\n    private<\/span> Vector3 m_InitialPosition;\n\n    void<\/span> Start<\/span>(<\/span>)\n    <\/span>{\n        m_InitialPosition = transform.position;\n    }\n\n    void<\/span> Update<\/span>(<\/span>)\n    <\/span>{\n        float<\/span> newY = Mathf.Sin(Time.time * Speed) * Height + m_InitialPosition.y;\n        transform.position = new<\/span> Vector3(transform.position.x, newY, transform.position.z);\n    }\n\n    public<\/span> override<\/span> List<string<\/span>> GetAssetReferences<\/span>(<\/span>) <\/span>{ return<\/span> null<\/span>; }\n    public<\/span> override<\/span> void<\/span> AfterDeserialization<\/span>(<\/span>) <\/span>{ }\n}\n<\/code><\/pre>\n\n\n\n
      Inspector View Example<\/h3>\n\n\n\n
      public<\/span> class<\/span> MyHoverComponentInspectorView<\/span> : DataComponentInspectorViewBase<\/span>\n<\/span>{\n    public<\/span> override<\/span> Type TypeOfDataComponent { get<\/span> => typeof(MyHoverComponent); }\n\n    public<\/span> override<\/span> void CreateInspectorEntries(VisualElement window, IReferenceProvider referenceProvider, IUIElementFactory elementFactory, object instance)\n    {\n        var<\/span> hoverComponent = instance as MyHoverComponent;\n        elementFactory.CreateInspectorFloatField(window, \"Speed\"<\/span>, hoverComponent.Speed, (oldValue, new<\/span>Value<\/span>) =>\n        {\n            hoverComponent.Speed = new<\/span>Value<\/span>;\n        });\n\n        elementFactory.CreateInspectorFloatField(window, \"Height\"<\/span>, hoverComponent.Height, (oldValue, new<\/span>Value<\/span>) =>\n        {\n            hoverComponent.Height = new<\/span>Value<\/span>;\n        });\n    }\n}\n<\/code><\/pre>\n\n\n\n
      Automatic Inspector Generation<\/h2>\n\n\n\n
      WorldBuilder provides automatic inspector view generation for common data types:<\/p>\n\n\n\n
        \n
      • Integer Fields<\/strong><\/li>\n\n\n\n
      • Float Fields<\/strong><\/li>\n\n\n\n
      • String Fields<\/strong><\/li>\n<\/ul>\n\n\n\n
        For components that want to expose more complex data types in the editor need to write a custom inspector view. Inheriting from DataComponentInspectorViewBase. In the examples you can find some basic custom inspector views.<\/p>\n\n\n\n
        Creating Custom Components: A Tutorial<\/h2>\n\n\n\n
        Step 1: Define Component Behavior<\/h3>\n\n\n\n
        Create a new C# script that inherits from DataComponentBase<\/code>. Define serializable properties using [JsonProperty]<\/code> attributes. Implement Unity’s lifecycle methods (Start()<\/code>, Update()<\/code>) to control behavior.<\/p>\n\n\n\n
        Step 2: Create Inspector View<\/h3>\n\n\n\n
        Create a corresponding inspector view class that inherits from DataComponentInspectorViewBase<\/code>. Implement the CreateInspectorEntries()<\/code> method to generate UI controls for each property using the appropriate element factory methods.<\/p>\n\n\n\n
        Step 3: Access Unity Libraries<\/h3>\n\n\n\n
        Utilize Unity’s classes and functions (e.g., Vector3<\/code>, Transform<\/code>, Mathf<\/code>, Time<\/code>) for movement, calculations, and object manipulation.<\/p>\n\n\n\n
        Step 4: Implement Required Methods<\/h3>\n\n\n\n
        All components must implement GetAssetReferences()<\/code> and AfterDeserialization()<\/code> methods to conform to the DataComponentBase<\/code> contract.<\/p>\n\n\n\n
        Component Types and Applications<\/h2>\n\n\n\n
        WorldBuilder’s example components demonstrate various interaction patterns:<\/p>\n\n\n\n
          \n
        • MyHoverComponent<\/strong>: Creates oscillating vertical movement using sine waves<\/li>\n\n\n\n
        • MyInteractivePulseComponent<\/strong>: Adjusts object scale rhythmically<\/li>\n\n\n\n
        • MyLookAtComponent<\/strong>: Orients objects toward specified targets<\/li>\n\n\n\n
        • MyOrbitComponent<\/strong>: Creates circular movement around target objects<\/li>\n<\/ul>\n\n\n\n
          Advanced Techniques<\/h2>\n\n\n\n
          Components can reference other scene objects by name:<\/p>\n\n\n\n
          [JsonProperty(\"TargetObjectName\"<\/span>)]\npublic<\/span> string TargetObjectName;\n\nvoid<\/span> Start<\/span>()<\/span>\n<\/span>{\n    var target<\/span> = GameObject.Find(TargetObjectName);\n    if<\/span> (target<\/span>)\n        m_TargetTransform = target<\/span>.transform;\n}\n<\/code><\/pre>\n\n\n\n
          This allows for complex interactions between objects in educational scenarios.<\/p>\n","protected":false},"excerpt":{"rendered":"
          Introduction to Runtime Scripting WorldBuilder’s runtime scripting system enables the creation of custom interactive components directly within the application environment using C# programming language. Technical Framework The runtime scripting implementation in WorldBuilder utilizes C# and the Unity engine’s core functionality. Components are created following a structured inheritance pattern: Component Structure A runtime component consists of…<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"doc_category":[16],"doc_tag":[],"class_list":["post-894","docs","type-docs","status-publish","hentry","doc_category-world-builder-extensions"],"year_month":"2025-08","word_count":463,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"maximilian.winter","author_nicename":"maximilian-winter","author_url":"https:\/\/www.portalsunited.com:443\/author\/maximilian-winter\/"},"doc_category_info":[{"term_name":"World Builder - Extensions","term_url":"https:\/\/www.portalsunited.com:443\/docs-category\/world-builder-extensions\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/docs\/894","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/comments?post=894"}],"version-history":[{"count":5,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/docs\/894\/revisions"}],"predecessor-version":[{"id":1246,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/docs\/894\/revisions\/1246"}],"wp:attachment":[{"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/media?parent=894"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/doc_category?post=894"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.portalsunited.com:443\/wp-json\/wp\/v2\/doc_tag?post=894"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}