Struct librojo::ProjectNode

pub struct ProjectNode {
    pub class_name: Option<String>,
    pub children: BTreeMap<String, ProjectNode>,
    pub properties: HashMap<String, UnresolvedValue>,
    pub ignore_unknown_instances: Option<bool>,
    pub path: Option<PathBuf>,
}

Describes an instance and its descendants in a project.

Fields

class_name: Option<String>

If set, defines the ClassName of the described instance.

$className MUST be set if $path is not set.

$className CANNOT be set if $path is set and the instance described by that path has a ClassName other than Folder.

children: BTreeMap<String, ProjectNode>

Contains all of the children of the described instance.

properties: HashMap<String, UnresolvedValue>

The properties that will be assigned to the resulting instance.

ignore_unknown_instances: Option<bool>

Defines the behavior when Rojo encounters unknown instances in Roblox Studio during live sync. $ignoreUnknownInstances should be considered a large hammer and used with care.

If set to true, those instances will be left alone. This may cause issues when files that turn into instances are removed while Rojo is not running.

If set to false, Rojo will destroy any instances it does not recognize.

If unset, its default value depends on other settings:

• If $path is not set, defaults to true
• If $path is set, defaults to false

path: Option<PathBuf>

Defines that this instance should come from the given file path. This path can point to any file type supported by Rojo, including Lua files (.lua), Roblox models (.rbxm, .rbxmx), and localization table spreadsheets (.csv).

Trait Implementations

impl Clone for ProjectNode

fn clone(&self) -> ProjectNode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProjectNode

fn default() -> ProjectNode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProjectNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ProjectNode> for ProjectNode

fn eq(&self, other: &ProjectNode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ProjectNode) -> bool

This method tests for !=.

impl Serialize for ProjectNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProjectNode