Fixed some bugs, generally refining stuff.
This commit is contained in:
CloneTrooper1019
2118
Tree/Enums.cs
Normal file
2118
Tree/Enums.cs
Normal file
File diff suppressed because it is too large
Load Diff
343
Tree/Instance.cs
Normal file
343
Tree/Instance.cs
Normal file
@ -0,0 +1,343 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
|
||||
namespace RobloxFiles
|
||||
{
|
||||
/// <summary>
|
||||
/// Describes an object in Roblox's DataModel hierarchy.
|
||||
/// Instances can have sets of properties loaded from *.rbxl/*.rbxm files.
|
||||
/// </summary>
|
||||
|
||||
public class Instance
|
||||
{
|
||||
/// <summary>The ClassName of this Instance.</summary>
|
||||
public readonly string ClassName;
|
||||
|
||||
/// <summary>A list of properties that are defined under this Instance.</summary>
|
||||
public List<Property> Properties = new List<Property>();
|
||||
|
||||
private List<Instance> Children = new List<Instance>();
|
||||
private Instance rawParent;
|
||||
|
||||
/// <summary>The name of this Instance, if a Name property is defined.</summary>
|
||||
public string Name => ReadProperty("Name", ClassName);
|
||||
public override string ToString() => Name;
|
||||
|
||||
/// <summary>Creates an instance using the provided ClassName.</summary>
|
||||
/// <param name="className">The ClassName to use for this Instance.</param>
|
||||
public Instance(string className = "Instance")
|
||||
{
|
||||
ClassName = className;
|
||||
}
|
||||
|
||||
/// <summary>Creates an instance using the provided ClassName and Name.</summary>
|
||||
/// <param name="className">The ClassName to use for this Instance.</param>
|
||||
/// <param name="name">The Name to use for this Instance.</param>
|
||||
public Instance(string className = "Instance", string name = "Instance")
|
||||
{
|
||||
Property propName = new Property();
|
||||
propName.Name = "Name";
|
||||
propName.Type = PropertyType.String;
|
||||
propName.Value = name;
|
||||
propName.Instance = this;
|
||||
|
||||
ClassName = className;
|
||||
Properties.Add(propName);
|
||||
}
|
||||
|
||||
/// <summary>Returns true if this Instance is an ancestor to the provided Instance.</summary>
|
||||
/// <param name="descendant">The instance whose descendance will be tested against this Instance.</param>
|
||||
public bool IsAncestorOf(Instance descendant)
|
||||
{
|
||||
while (descendant != null)
|
||||
{
|
||||
if (descendant == this)
|
||||
return true;
|
||||
|
||||
descendant = descendant.Parent;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>Returns true if this Instance is a descendant of the provided Instance.</summary>
|
||||
/// <param name="ancestor">The instance whose ancestry will be tested against this Instance.</param>
|
||||
public bool IsDescendantOf(Instance ancestor)
|
||||
{
|
||||
return ancestor.IsAncestorOf(this);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The parent of this Instance, or null if the instance is the root of a tree.<para/>
|
||||
/// Setting the value of this property will throw an exception if:<para/>
|
||||
/// - The value is set to itself.<para/>
|
||||
/// - The value is a descendant of the Instance.
|
||||
/// </summary>
|
||||
public Instance Parent
|
||||
{
|
||||
get
|
||||
{
|
||||
return rawParent;
|
||||
}
|
||||
set
|
||||
{
|
||||
if (IsAncestorOf(value))
|
||||
throw new Exception("Parent would result in circular reference.");
|
||||
|
||||
if (Parent == this)
|
||||
throw new Exception("Attempt to set parent to self.");
|
||||
|
||||
if (rawParent != null)
|
||||
rawParent.Children.Remove(this);
|
||||
|
||||
value.Children.Add(this);
|
||||
rawParent = value;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a snapshot of the Instances currently parented to this Instance, as an array.
|
||||
/// </summary>
|
||||
public Instance[] GetChildren()
|
||||
{
|
||||
return Children.ToArray();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a snapshot of the Instances that are descendants of this Instance, as an array.
|
||||
/// </summary>
|
||||
public Instance[] GetDescendants()
|
||||
{
|
||||
List<Instance> results = new List<Instance>();
|
||||
|
||||
foreach (Instance child in Children)
|
||||
{
|
||||
// Add this child to the results.
|
||||
results.Add(child);
|
||||
|
||||
// Add its descendants to the results.
|
||||
Instance[] descendants = child.GetDescendants();
|
||||
results.AddRange(descendants);
|
||||
}
|
||||
|
||||
return results.ToArray();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the first child of this Instance whose Name is the provided string name.
|
||||
/// If the instance is not found, this returns null.
|
||||
/// </summary>
|
||||
/// <param name="name">The Name of the Instance to find.</param>
|
||||
/// <param name="recursive">Indicates if we should search descendants as well.</param>
|
||||
public Instance FindFirstChild(string name, bool recursive = false)
|
||||
{
|
||||
Instance result = null;
|
||||
var query = Children.Where((child) => name == child.Name);
|
||||
|
||||
if (query.Count() > 0)
|
||||
{
|
||||
result = query.First();
|
||||
}
|
||||
else if (recursive)
|
||||
{
|
||||
foreach (Instance child in Children)
|
||||
{
|
||||
Instance found = child.FindFirstChild(name, true);
|
||||
|
||||
if (found != null)
|
||||
{
|
||||
result = found;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the first ancestor of this Instance whose Name is the provided string name.
|
||||
/// If the instance is not found, this returns null.
|
||||
/// </summary>
|
||||
/// <param name="name">The Name of the Instance to find.</param>
|
||||
public Instance FindFirstAncestor(string name)
|
||||
{
|
||||
Instance ancestor = Parent;
|
||||
|
||||
while (ancestor != null)
|
||||
{
|
||||
if (ancestor.Name == name)
|
||||
break;
|
||||
|
||||
ancestor = ancestor.Parent;
|
||||
}
|
||||
|
||||
return ancestor;
|
||||
}
|
||||
|
||||
public Instance FindFirstAncestorOfClass(string className)
|
||||
{
|
||||
Instance ancestor = Parent;
|
||||
|
||||
while (ancestor != null)
|
||||
{
|
||||
if (ancestor.ClassName == className)
|
||||
break;
|
||||
|
||||
ancestor = ancestor.Parent;
|
||||
}
|
||||
|
||||
return ancestor;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the first Instance whose ClassName is the provided string className. If the instance is not found, this returns null.
|
||||
/// </summary>
|
||||
/// <param name="className">The ClassName of the Instance to find.</param>
|
||||
public Instance FindFirstChildOfClass(string className, bool recursive = false)
|
||||
{
|
||||
Instance result = null;
|
||||
var query = Children.Where((child) => className == child.ClassName);
|
||||
|
||||
if (query.Count() > 0)
|
||||
result = query.First();
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a string descrbing the index traversal of this Instance, starting from its root ancestor.
|
||||
/// </summary>
|
||||
public string GetFullName()
|
||||
{
|
||||
string fullName = Name;
|
||||
Instance at = Parent;
|
||||
|
||||
while (at != null)
|
||||
{
|
||||
fullName = at.Name + '.' + fullName;
|
||||
at = at.Parent;
|
||||
}
|
||||
|
||||
return fullName;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks for a property with the specified property name, and returns it as an object.
|
||||
/// <para/>The resulting value may be null if the property is not serialized.
|
||||
/// <para/>You can use the templated ReadProperty overload to fetch it as a specific type with a default value provided.
|
||||
/// </summary>
|
||||
/// <param name="propertyName">The name of the property to be fetched from this Instance.</param>
|
||||
/// <returns>An object reference to the value of the specified property, if it exists.</returns>
|
||||
///
|
||||
public object ReadProperty(string propertyName)
|
||||
{
|
||||
Property property = null;
|
||||
|
||||
var query = Properties.Where((prop) => prop.Name.ToLower() == propertyName.ToLower());
|
||||
if (query.Count() > 0)
|
||||
property = query.First();
|
||||
|
||||
return (property != null ? property.Value : null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks for a property with the specified property name, and returns it as the specified type.<para/>
|
||||
/// If it cannot be converted, the provided nullFallback value will be returned instead.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The value type to convert to when finding the specified property name.</typeparam>
|
||||
/// <param name="propertyName">The name of the property to be fetched from this Instance.</param>
|
||||
/// <param name="nullFallback">A fallback value to be returned if casting to T fails, or the property is not found.</param>
|
||||
/// <returns></returns>
|
||||
public T ReadProperty<T>(string propertyName, T nullFallback)
|
||||
{
|
||||
try
|
||||
{
|
||||
object result = ReadProperty(propertyName);
|
||||
return (T)result;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return nullFallback;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Looks for a property with the specified property name. If found, it will try to set the value of the referenced outValue to its value.<para/>
|
||||
/// Returns true if the property was found and its value was casted to the referenced outValue.<para/>
|
||||
/// If it returns false, the outValue will not have its value set.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The value type to convert to when finding the specified property name.</typeparam>
|
||||
/// <param name="propertyName">The name of the property to be fetched from this Instance.</param>
|
||||
/// <param name="outValue">The value to write to if the property can be casted to T correctly.</param>
|
||||
public bool TryReadProperty<T>(string propertyName, ref T outValue)
|
||||
{
|
||||
try
|
||||
{
|
||||
object result = ReadProperty(propertyName);
|
||||
outValue = (T)result;
|
||||
|
||||
return true;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds a property by reference to this Instance's property list.
|
||||
/// This is used during the file loading procedure.
|
||||
/// </summary>
|
||||
/// <param name="prop">A reference to the property that will be added.</param>
|
||||
public void AddProperty(ref Property prop)
|
||||
{
|
||||
Properties.Add(prop);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Allows you to access a child/descendant of this Instance, and/or one of its properties.<para/>
|
||||
/// The provided string should be a period-separated (.) path to what you wish to access.<para/>
|
||||
/// This will throw an exception if any part of the path cannot be found.<para/>
|
||||
///
|
||||
/// ~ Examples ~<para/>
|
||||
/// var terrain = robloxFile["Workspace.Terrain"] as Instance;<para/>
|
||||
/// var currentCamera = robloxFile["Workspace.CurrentCamera"] as Property;<para/>
|
||||
///
|
||||
/// </summary>
|
||||
public object this[string accessor]
|
||||
{
|
||||
get
|
||||
{
|
||||
Instance result = this;
|
||||
|
||||
foreach (string name in accessor.Split('.'))
|
||||
{
|
||||
Instance next = result.FindFirstChild(name);
|
||||
|
||||
if (next == null)
|
||||
{
|
||||
// Check if there is any property with this name.
|
||||
var propQuery = result.Properties
|
||||
.Where((prop) => name == prop.Name);
|
||||
|
||||
if (propQuery.Count() > 0)
|
||||
{
|
||||
var prop = propQuery.First();
|
||||
return prop;
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new Exception(name + " is not a valid member of " + result.Name);
|
||||
}
|
||||
}
|
||||
|
||||
result = next;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
108
Tree/Property.cs
Normal file
108
Tree/Property.cs
Normal file
@ -0,0 +1,108 @@
|
||||
using System;
|
||||
|
||||
namespace RobloxFiles
|
||||
{
|
||||
public enum PropertyType
|
||||
{
|
||||
Unknown,
|
||||
String,
|
||||
Bool,
|
||||
Int,
|
||||
Float,
|
||||
Double,
|
||||
UDim,
|
||||
UDim2,
|
||||
Ray,
|
||||
Faces,
|
||||
Axes,
|
||||
BrickColor,
|
||||
Color3,
|
||||
Vector2,
|
||||
Vector3,
|
||||
Vector2int16,
|
||||
CFrame,
|
||||
Quaternion,
|
||||
Enum,
|
||||
Ref,
|
||||
Vector3int16,
|
||||
NumberSequence,
|
||||
ColorSequence,
|
||||
NumberRange,
|
||||
Rect,
|
||||
PhysicalProperties,
|
||||
Color3uint8,
|
||||
Int64
|
||||
}
|
||||
|
||||
public class Property
|
||||
{
|
||||
public string Name;
|
||||
public Instance Instance;
|
||||
|
||||
public PropertyType Type;
|
||||
public object Value;
|
||||
|
||||
private byte[] RawBuffer = null;
|
||||
public bool HasRawBuffer
|
||||
{
|
||||
get
|
||||
{
|
||||
if (RawBuffer == null && Value != null)
|
||||
{
|
||||
// Improvise what the buffer should be if this is a primitive.
|
||||
switch (Type)
|
||||
{
|
||||
case PropertyType.Int:
|
||||
RawBuffer = BitConverter.GetBytes((int)Value);
|
||||
break;
|
||||
case PropertyType.Int64:
|
||||
RawBuffer = BitConverter.GetBytes((long)Value);
|
||||
break;
|
||||
case PropertyType.Bool:
|
||||
RawBuffer = BitConverter.GetBytes((bool)Value);
|
||||
break;
|
||||
case PropertyType.Float:
|
||||
RawBuffer = BitConverter.GetBytes((float)Value);
|
||||
break;
|
||||
case PropertyType.Double:
|
||||
RawBuffer = BitConverter.GetBytes((double)Value);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return (RawBuffer != null);
|
||||
}
|
||||
}
|
||||
|
||||
public string GetFullName()
|
||||
{
|
||||
string result = Name;
|
||||
|
||||
if (Instance != null)
|
||||
result = Instance.GetFullName() + '.' + result;
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
string typeName = Enum.GetName(typeof(PropertyType), Type);
|
||||
string valueLabel = (Value != null ? Value.ToString() : "null");
|
||||
|
||||
if (Type == PropertyType.String)
|
||||
valueLabel = '"' + valueLabel + '"';
|
||||
|
||||
return string.Join(" ", typeName, Name, '=', valueLabel);
|
||||
}
|
||||
|
||||
internal void SetRawBuffer(byte[] buffer)
|
||||
{
|
||||
RawBuffer = buffer;
|
||||
}
|
||||
|
||||
public byte[] GetRawBuffer()
|
||||
{
|
||||
return RawBuffer;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user