Description
The BaseSurface
property represents the filepath of the base surface for a Surface
object in the Sandbox environment. It serves as a fallback surface for any empty fields on the current surface. This property is essential for defining the default characteristics and behaviors of a surface when specific attributes are not explicitly set.
Usage
To set the base surface, use the SetBaseSurface
method with the desired surface filepath as a string argument. To retrieve the current base surface, use the GetBaseSurface
method, which returns a Surface
object representing the base surface.
Example
// Example of setting and getting the BaseSurface property
// Create a new Surface object
Surface mySurface = new Surface();
// Set the base surface using a filepath
mySurface.SetBaseSurface("path/to/base/surface");
// Retrieve the base surface
Surface baseSurface = mySurface.GetBaseSurface();
// Output the base surface filepath
string baseSurfacePath = mySurface.BaseSurface;
// baseSurfacePath should now contain "path/to/base/surface"