Rule Tile custom Output types

IsItHayden · October 4, 2024, 5:35am

Hi,

Under Tiling Rules, I’m looking for a way to add different output types to the Built-In rule tiles. I would like to create a

The current options are:

Single
Random
Animation

However I would like to add new output types - like Weighted Random - to this. Currently, the only way that this functionality -might- be possible is likely just by creating another custom rule tile for this explicit purpose. However, I have other Custom rule tiles that I would like to have this functionality on as well.

Does anyone have any insights on this? It would be a massive help, cheers.

Lo-renzo · October 4, 2024, 6:52am

You could create your own custom RuleTile based on the original. Editing the script to have another option there shouldn’t too hard.

github.com

Unity-Technologies/2d-extras/blob/master/Runtime/Tiles/RuleTile/RuleTile.cs

using System;
using System.Linq;
using System.Reflection;
using System.Collections.Generic;
using UnityEngine.Tilemaps;
using UnityEngine.Serialization;

namespace UnityEngine
{
    /// <summary>
    /// Generic visual tile for creating different tilesets like terrain, pipeline, random or animated tiles.
    /// This is templated to accept a Neighbor Rule Class for Custom Rules.
    /// </summary>
    /// <typeparam name="T">Neighbor Rule Class for Custom Rules</typeparam>
    public class RuleTile<T> : RuleTile
    {
        /// <summary>
        /// Returns the Neighbor Rule Class type for this Rule Tile.
        /// </summary>
        public sealed override Type m_NeighborType => typeof(T);

This file has been truncated. show original

The hard part is this also requires customizing the RuleTileEditor, which is a behemoth.

github.com

Unity-Technologies/2d-extras/blob/master/Editor/Tiles/RuleTile/RuleTileEditor.cs

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Linq;
using UnityEditorInternal;
using UnityEngine;
using UnityEngine.Tilemaps;
using Object = UnityEngine.Object;

namespace UnityEditor
{
    /// <summary>
    /// The Editor for a RuleTile.
    /// </summary>
    [CustomEditor(typeof(RuleTile), true)]
    [CanEditMultipleObjects]
    public class RuleTileEditor : Editor
    {
        private const string s_XIconString = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAABoSURBVDhPnY3BDcAgDAOZhS14dP1O0x2C/LBEgiNSHvfwyZabmV0jZRUpq2zi6f0DJwdcQOEdwwDLypF0zHLMa9+NQRxkQ+ACOT2STVw/q8eY1346ZlE54sYAhVhSDrjwFymrSFnD2gTZpls2OvFUHAAAAABJRU5ErkJggg==";
        private const string s_Arrow0 = "iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuNWWFMmUAAACYSURBVDhPzZExDoQwDATzE4oU4QXXcgUFj+YxtETwgpMwXuFcwMFSRMVKKwzZcWzhiMg91jtg34XIntkre5EaT7yjjhI9pOD5Mw5k2X/DdUwFr3cQ7Pu23E/BiwXyWSOxrNqx+ewnsayam5OLBtbOGPUM/r93YZL4/dhpR/amwByGFBz170gNChA6w5bQQMqramBTgJ+Z3A58WuWejPCaHQAAAABJRU5ErkJggg==";

This file has been truncated. show original

IsItHayden · October 5, 2024, 9:32am

Thanks for the reply!

I tried modifying the original RuleTile script but it keeps erasing my edits, so I assume I’m not supposed to do that…

I’m not too sure about how I would go about it another way.

In general, it would be nice if there were a cleaner way to add new outputs.

spiney199 · October 5, 2024, 10:07am

The output mode is just an enum, so there is no clean way to extend it. In its defence, RuleTile’s were coded well before more flexible options like [SerializeReference] existed. Though to do so would probably need a new package built from the ground up.

In any case, they don’t mean edit the existing script, but make your own script in your own project that re-implements what you need, alongside modifying/extending whatever else you need. You can likely inherit from RuleTile and RuleTileEditor to reuse a lot of the implementation, or recode it entirely.

IsItHayden · October 6, 2024, 9:55am

Ah, I see! I may have to do it myself as a side project one day. Thanks!

Topic		Replies	Views
Extending functionality of RuleTile? Unity Engine Scripting	4	3166	August 6, 2021
Tileset rules with multiple tilesets Unity Engine 2D	13	16468	November 23, 2022
Unity Rule Tile: How to Set Random GameObject Output Instead of Sprite for a Tiling Rule? Unity Engine Tilemap , Intermediate , Question , 6-0	2	245	November 8, 2024
Expand TilingRuleOutput properties in custom rule tile Unity Engine 2D , Question	2	730	July 22, 2023
Frustrations with extending Tile (Tilemap) Unity Engine 2D , Feedback	13	2253	February 4, 2023

Rule Tile custom Output types

Related topics