Nasal library/os.path
Jump to navigation
Jump to search
The FlightGear forum has a subforum related to: Nasal Scripting |
Nasal scripting |
---|
Nasal internals |
---|
Memory Management (GC) |
This page contains documentation for the os.path
namespace in Nasal. This namespace implements tools (from SGPath) for manipulating file paths. Everything in the geo
namespace is sourced from flightgear/src/Scripting/NasalSGPath.cxx
Tip Copy & paste the examples into your Nasal Console and execute them to see what they do. |
Note Everything here was added to FlightGear 3.0. |
Class
os.path
A pseudo-class (actually a Nasal ghost). This is the main class that stores and allows manipulation of file paths. This is also integrated into the os.path
.
new()
os.path.new([path]);
Constructor function. Returns a new os.path
instance. Note that the path must not violate the rules for allowed paths.
- path
- Optional string specifying the filepath. If not given, the path will default to $FG_ROOT
Examples
var path = os.path.new();
print(path.realpath); # will print $FGROOT
var path = os.path.new("C:/Windows"); # Windows filepath
# var path = os.path.new("/usr/bin/"); # Unix filepath
print(path.realpath);
set()
os.path.set([path]);
Sets the filepath. Note that the path must not violate the rules for allowed paths.
- path
- Optional string specifying the filepath. If not given, the path will be set to $FG_ROOT
Examples
var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
print(path.realpath);
path.set();
print(path.realpath); # will print $FG_ROOT
var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
print(path.realpath);
path.set("C:/Windows/Program Files");
# path.set("/usr/"); # alternative Unix filepath
print(path.realpath); # prints new path
append()
os.path.append([path]);
Appends a new part to the filepath.
- path
- Optional string specifying the filepath. If not given, the resultant path will not change.
Examples
var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/"); # alternative Unix filepath
print(path.realpath);
path.append();
print(path.realpath); # the path will not change
var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/"); # alternative Unix filepath
print(path.realpath);
path.append("Program Files");
# path.set("bin"); # alternative Unix filepath
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"