Torque3D Documentation / _generateds / platformVolume.h

platformVolume.h

Engine/source/platform/platformVolume.h

More...

Namespaces:

namespace
namespace

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _PLATFORMVOLUME_H_
25#define _PLATFORMVOLUME_H_
26
27#include "core/volume.h"
28
29
30namespace Platform
31{
32namespace FS
33{
34   using namespace Torque;
35   using namespace Torque::FS;
36
37   FileSystemRef  createNativeFS( const String &volume );
38
39   String   getAssetDir();
40
41   /// Mount default OS file systems.
42   /// On POSIX environment this means mounting a root FileSystem "/", mounting
43   /// the $HOME environment variable as the "home:/" file system and setting the
44   /// current working directory to the current OS working directory.
45   bool InstallFileSystems();
46
47   bool MountDefaults();
48   bool MountZips(const String &root);
49   
50   bool Touch( const Path &path );
51
52} // Namespace FS
53} // Namespace Platform
54
55#endif
56
57