Skip to content

Commit 04a02c1

Browse files
author
Chris Elion
authored
[MLA-1939] Match3 Custom Editor (#5263)
1 parent 3cf5968 commit 04a02c1

14 files changed

+135
-21
lines changed

‎Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuator.cs

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
using Unity.MLAgents;
21
using Unity.MLAgents.Integrations.Match3;
32

43
namespace Unity.MLAgentsExamples

‎Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuatorComponent.cs

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ public class Match3ExampleActuatorComponent : Match3ActuatorComponent
1010
public override IActuator[] CreateActuators()
1111
{
1212
var board = GetComponent<Match3Board>();
13-
var agent = GetComponentInParent<Agent>();
1413
var seed = RandomSeed == -1 ? gameObject.GetInstanceID() : RandomSeed + 1;
1514
return new IActuator[] { new Match3ExampleActuator(board, ForceHeuristic, ActuatorName, seed) };
1615
}

‎com.unity.ml-agents/Editor/BufferSensorComponentEditor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Unity.MLAgents.Editor
55
{
6-
[CustomEditor(typeof(BufferSensorComponent))]
6+
[CustomEditor(typeof(BufferSensorComponent), editorForChildClasses: true)]
77
[CanEditMultipleObjects]
88
internal class BufferSensorComponentEditor : UnityEditor.Editor
99
{

‎com.unity.ml-agents/Editor/CameraSensorComponentEditor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Unity.MLAgents.Editor
55
{
6-
[CustomEditor(typeof(CameraSensorComponent))]
6+
[CustomEditor(typeof(CameraSensorComponent), editorForChildClasses: true)]
77
[CanEditMultipleObjects]
88
internal class CameraSensorComponentEditor : UnityEditor.Editor
99
{

‎com.unity.ml-agents/Editor/GridSensorComponentEditor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace Unity.MLAgents.Editor
66
{
7-
[CustomEditor(typeof(GridSensorComponent))]
7+
[CustomEditor(typeof(GridSensorComponent), editorForChildClasses: true)]
88
[CanEditMultipleObjects]
99
internal class GridSensorComponentEditor : UnityEditor.Editor
1010
{

‎com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
using UnityEditor;
2+
using Unity.MLAgents.Integrations.Match3;
3+
namespace Unity.MLAgents.Editor
4+
{
5+
[CustomEditor(typeof(Match3ActuatorComponent), editorForChildClasses: true)]
6+
[CanEditMultipleObjects]
7+
internal class Match3ActuatorComponentEditor : UnityEditor.Editor
8+
{
9+
public override void OnInspectorGUI()
10+
{
11+
var so = serializedObject;
12+
so.Update();
13+
14+
// Drawing the RenderTextureComponent
15+
EditorGUI.BeginChangeCheck();
16+
17+
EditorGUI.BeginDisabledGroup(!EditorUtilities.CanUpdateModelProperties());
18+
{
19+
EditorGUILayout.PropertyField(so.FindProperty("m_ActuatorName"), true);
20+
EditorGUILayout.PropertyField(so.FindProperty("m_RandomSeed"), true);
21+
}
22+
EditorGUI.EndDisabledGroup();
23+
EditorGUILayout.PropertyField(so.FindProperty("m_ForceHeuristic"), true);
24+
25+
var requireSensorUpdate = EditorGUI.EndChangeCheck();
26+
so.ApplyModifiedProperties();
27+
28+
if (requireSensorUpdate)
29+
{
30+
UpdateActuator();
31+
}
32+
}
33+
34+
void UpdateActuator()
35+
{
36+
}
37+
}
38+
}

‎com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
using UnityEditor;
2+
using Unity.MLAgents.Integrations.Match3;
3+
namespace Unity.MLAgents.Editor
4+
{
5+
[CustomEditor(typeof(Match3SensorComponent), editorForChildClasses: true)]
6+
[CanEditMultipleObjects]
7+
internal class Match3SensorComponentEditor : UnityEditor.Editor
8+
{
9+
public override void OnInspectorGUI()
10+
{
11+
var so = serializedObject;
12+
so.Update();
13+
14+
// Drawing the RenderTextureComponent
15+
EditorGUI.BeginChangeCheck();
16+
17+
EditorGUI.BeginDisabledGroup(!EditorUtilities.CanUpdateModelProperties());
18+
{
19+
EditorGUILayout.PropertyField(so.FindProperty("m_SensorName"), true);
20+
EditorGUILayout.PropertyField(so.FindProperty("m_ObservationType"), true);
21+
}
22+
EditorGUI.EndDisabledGroup();
23+
24+
var requireSensorUpdate = EditorGUI.EndChangeCheck();
25+
so.ApplyModifiedProperties();
26+
27+
if (requireSensorUpdate)
28+
{
29+
UpdateSensor();
30+
}
31+
}
32+
33+
void UpdateSensor()
34+
{
35+
}
36+
}
37+
}

‎com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎com.unity.ml-agents/Editor/RayPerceptionSensorComponentBaseEditor.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ void UpdateSensorIfDirty()
8787
}
8888
}
8989

90-
[CustomEditor(typeof(RayPerceptionSensorComponent2D))]
90+
[CustomEditor(typeof(RayPerceptionSensorComponent2D), editorForChildClasses: true)]
9191
[CanEditMultipleObjects]
9292
internal class RayPerceptionSensorComponent2DEditor : RayPerceptionSensorComponentBaseEditor
9393
{
@@ -97,7 +97,7 @@ public override void OnInspectorGUI()
9797
}
9898
}
9999

100-
[CustomEditor(typeof(RayPerceptionSensorComponent3D))]
100+
[CustomEditor(typeof(RayPerceptionSensorComponent3D), editorForChildClasses: true)]
101101
[CanEditMultipleObjects]
102102
internal class RayPerceptionSensorComponent3DEditor : RayPerceptionSensorComponentBaseEditor
103103
{

‎com.unity.ml-agents/Editor/RenderTextureSensorComponentEditor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using Unity.MLAgents.Sensors;
33
namespace Unity.MLAgents.Editor
44
{
5-
[CustomEditor(typeof(RenderTextureSensorComponent))]
5+
[CustomEditor(typeof(RenderTextureSensorComponent), editorForChildClasses: true)]
66
[CanEditMultipleObjects]
77
internal class RenderTextureSensorComponentEditor : UnityEditor.Editor
88
{

‎com.unity.ml-agents/Editor/VectorSensorComponentEditor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Unity.MLAgents.Editor
55
{
6-
[CustomEditor(typeof(VectorSensorComponent))]
6+
[CustomEditor(typeof(VectorSensorComponent), editorForChildClasses: true)]
77
[CanEditMultipleObjects]
88
internal class VectorSensorComponentEditor : UnityEditor.Editor
99
{

‎com.unity.ml-agents/Runtime/Integrations/Match3/Match3ActuatorComponent.cs

+28-8
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,50 @@ namespace Unity.MLAgents.Integrations.Match3
1010
[AddComponentMenu("ML Agents/Match 3 Actuator", (int)MenuGroup.Actuators)]
1111
public class Match3ActuatorComponent : ActuatorComponent
1212
{
13+
[HideInInspector, SerializeField, FormerlySerializedAs("ActuatorName")]
14+
string m_ActuatorName = "Match3 Actuator";
15+
1316
/// <summary>
1417
/// Name of the generated Match3Actuator object.
1518
/// Note that changing this at runtime does not affect how the Agent sorts the actuators.
1619
/// </summary>
17-
public string ActuatorName = "Match3 Actuator";
20+
public string ActuatorName
21+
{
22+
get => m_ActuatorName;
23+
set => m_ActuatorName = value;
24+
}
25+
26+
[HideInInspector, SerializeField, FormerlySerializedAs("RandomSeed")]
27+
int m_RandomSeed = -1;
1828

1929
/// <summary>
20-
/// A random seed used to generate a board, if needed.
30+
/// A random seed used in the actuator's heuristic, if needed.
2131
/// </summary>
22-
public int RandomSeed = -1;
32+
public int RandomSeed
33+
{
34+
get => m_RandomSeed;
35+
set => m_RandomSeed = value;
36+
}
37+
38+
[HideInInspector, SerializeField, FormerlySerializedAs("ForceHeuristic")]
39+
[Tooltip("Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.")]
40+
bool m_ForceHeuristic;
2341

2442
/// <summary>
2543
/// Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.
2644
/// </summary>
27-
[FormerlySerializedAs("ForceRandom")]
28-
[Tooltip("Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.")]
29-
public bool ForceHeuristic;
45+
public bool ForceHeuristic
46+
{
47+
get => m_ForceHeuristic;
48+
set => m_ForceHeuristic = value;
49+
}
3050

3151
/// <inheritdoc/>
3252
public override IActuator[] CreateActuators()
3353
{
3454
var board = GetComponent<AbstractBoard>();
35-
var seed = RandomSeed == -1 ? gameObject.GetInstanceID() : RandomSeed + 1;
36-
return new IActuator[] { new Match3Actuator(board, ForceHeuristic, seed, ActuatorName) };
55+
var seed = m_RandomSeed == -1 ? gameObject.GetInstanceID() : m_RandomSeed + 1;
56+
return new IActuator[] { new Match3Actuator(board, m_ForceHeuristic, seed, m_ActuatorName) };
3757
}
3858

3959
/// <inheritdoc/>

‎com.unity.ml-agents/Runtime/Integrations/Match3/Match3SensorComponent.cs

+19-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using System;
22
using Unity.MLAgents.Sensors;
33
using UnityEngine;
4+
using UnityEngine.Serialization;
45

56
namespace Unity.MLAgents.Integrations.Match3
67
{
@@ -10,16 +11,30 @@ namespace Unity.MLAgents.Integrations.Match3
1011
[AddComponentMenu("ML Agents/Match 3 Sensor", (int)MenuGroup.Sensors)]
1112
public class Match3SensorComponent : SensorComponent, IDisposable
1213
{
14+
[HideInInspector, SerializeField, FormerlySerializedAs("SensorName")]
15+
string m_SensorName = "Match3 Sensor";
16+
1317
/// <summary>
1418
/// Name of the generated Match3Sensor object.
1519
/// Note that changing this at runtime does not affect how the Agent sorts the sensors.
1620
/// </summary>
17-
public string SensorName = "Match3 Sensor";
21+
public string SensorName
22+
{
23+
get => m_SensorName;
24+
set => m_SensorName = value;
25+
}
26+
27+
[HideInInspector, SerializeField, FormerlySerializedAs("ObservationType")]
28+
Match3ObservationType m_ObservationType = Match3ObservationType.Vector;
1829

1930
/// <summary>
2031
/// Type of observation to generate.
2132
/// </summary>
22-
public Match3ObservationType ObservationType = Match3ObservationType.Vector;
33+
public Match3ObservationType ObservationType
34+
{
35+
get => m_ObservationType;
36+
set => m_ObservationType = value;
37+
}
2338

2439
private ISensor[] m_Sensors;
2540

@@ -30,9 +45,9 @@ public override ISensor[] CreateSensors()
3045
Dispose();
3146

3247
var board = GetComponent<AbstractBoard>();
33-
var cellSensor = Match3Sensor.CellTypeSensor(board, ObservationType, SensorName + " (cells)");
48+
var cellSensor = Match3Sensor.CellTypeSensor(board, m_ObservationType, m_SensorName + " (cells)");
3449
// This can be null if numSpecialTypes is 0
35-
var specialSensor = Match3Sensor.SpecialTypeSensor(board, ObservationType, SensorName + " (special)");
50+
var specialSensor = Match3Sensor.SpecialTypeSensor(board, m_ObservationType, m_SensorName + " (special)");
3651
m_Sensors = specialSensor != null
3752
? new ISensor[] { cellSensor, specialSensor }
3853
: new ISensor[] { cellSensor };

0 commit comments

Comments
 (0)