pub struct Project {
pub name: String,
pub tree: ProjectNode,
pub serve_port: Option<u16>,
pub serve_place_ids: Option<HashSet<u64>>,
pub place_id: Option<u64>,
pub game_id: Option<u64>,
pub serve_address: Option<IpAddr>,
pub emit_legacy_scripts: Option<bool>,
pub glob_ignore_paths: Vec<Glob>,
pub file_location: PathBuf,
}
Expand description
Contains all of the configuration for a Rojo-managed project.
Project files are stored in .project.json
files.
Fields§
§name: String
The name of the top-level instance described by the project.
tree: ProjectNode
The tree of instances described by this project. Projects always describe at least one instance.
serve_port: Option<u16>
If specified, sets the default port that rojo serve
should use when
using this project for live sync.
serve_place_ids: Option<HashSet<u64>>
If specified, contains the set of place IDs that this project is compatible with when doing live sync.
This setting is intended to help prevent syncing a Rojo project into the wrong Roblox place.
place_id: Option<u64>
If specified, sets the current place’s place ID when connecting to the Rojo server from Roblox Studio.
game_id: Option<u64>
If specified, sets the current place’s game ID when connecting to the Rojo server from Roblox Studio.
serve_address: Option<IpAddr>
If specified, this address will be used in place of the default address As long as –address is unprovided.
emit_legacy_scripts: Option<bool>
Determines if rojo should emit scripts with the appropriate RunContext
for *.client.lua
and *.server.lua
files in the project.
Or, if rojo should keep the legacy behavior of emitting LocalScripts and Scripts with legacy Runcontext
glob_ignore_paths: Vec<Glob>
A list of globs, relative to the folder the project file is in, that match files that should be excluded if Rojo encounters them.
file_location: PathBuf
The path to the file that this project came from. Relative paths in the
project should be considered relative to the parent of this field, also
given by Project::folder_location
.
Implementations§
source§impl Project
impl Project
sourcepub fn is_project_file(path: &Path) -> bool
pub fn is_project_file(path: &Path) -> bool
Tells whether the given path describes a Rojo project.