Fs.combine - Revision history

Hawk777: Copy description from API page and use type template

2013-04-22T19:43:32Z

Copy description from API page and use type template

AfterLifeLochie: Corrected broken links.

2012-11-30T12:22:07Z

Corrected broken links.

AfterLifeLochie: Moved to CAT:LuaCoreFunctions

2012-11-28T18:46:20Z

Moved to CAT:LuaCoreFunctions

Hawk777: Create page

2012-03-12T04:16:21Z

Create page

New page

{{lowercase}}
{{Function
|name=fs.combine
|args=[[string (type)|string]] basePath, [[string(type)|string]] localPath
|api=fs
|returns=[[string]] the combined path
|desc=Combines two paths, such that the new path consists of all the components of <var>localPath</var> inside all the components of <var>basePath</var> (neither path needs to exist; this function only manipulates strings and does not touch the filesystem)
|examples=
{{Example
|desc=Computes the absolute path to a file called "d" inside a directory called "c", where "c" is itself inside a directory "b" which is inside a directory "a"
|code=print(fs.combine("a/b", "c/d"))
|output=a/b/c/d
}}
{{Example
|desc=An empty first path refers to the root directory, so the second path is returned
|code=print(fs.combine("", "c/d"))
|output=c/d
}}
{{Example
|desc=An empty second path refers to the first path directly, so the first path is returned
|code=print(fs.combine("a/b", ""))
|output=a/b
}}
{{Example
|desc=The last two examples make sense combined, returning the empty string (referring to the root directory)
|code=print(fs.combine("", ""))
|output=
}}
}}

@@ Line 2: / Line 2: @@
 {{Function
 |name=fs.combine
-|args=[[String_(type)|string]] basePath, [[String_(type)|string]] localPath
+|args={{Type|string}} basePath, {{Type|string}} localPath
 |api=fs
-|returns=[[String_(type)|string]] the combined path
+|returns={{Type|string}} the combined path
-|desc=Combines two paths, such that the new path consists of all the components of <var>localPath</var> inside all the components of <var>basePath</var> (neither path needs to exist; this function only manipulates strings and does not touch the filesystem)
+|desc=Combines two path components, returning a path consisting of the local path nested inside the base path. The resultant path consists of all the components of <var>localPath</var> inside all the components of <var>basePath</var>. Neither path needs to exist; this function only manipulates strings and does not touch the filesystem.
 |examples=
 {{Example

← Older revision		Revision as of 18:46, 28 November 2012
Line 28:		Line 28:
	}}		}}
	}}		}}
		+
		+	[[Category:Lua_Core_Functions]]