Scene:GetArea

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
m (Removed stub tag.)
m (updating function page)
Line 1: Line 1:
{{LuaFunction
{{LuaFunction
-
|function_name       = GetArea
+
|function_name =GetArea
-
|arguments           = ([[string]]) Name of area to get
+
|arguments =* The name of the Area to try to get.
-
|returns             = [[Area]]
+
|returns =A pointer to the Area asked for. 0 if no Area of that name was found.
-
|description         = Returns the object that represents specified area defined in scene.ini.
+
|description =
-
|}}
+
Gets a specific Area identified by a name. Ownership is NOT transferred!
 +
  }}

Revision as of 00:13, 28 June 2012

Function
SyntaxGetArea( * The name of the Area to try to get. )
Description:
Gets a specific Area identified by a name. Ownership is NOT transferred!
ReturnsA pointer to the Area asked for. 0 if no Area of that name was found.




Example
DescriptionPlaceholder!
Code
  1. for k,v in pairs(PagesWithoutExamples) do
  2.     v.MakeExample(NoErrors);
  3. end
OutputPlaceholder!
Retrieved from "https://wiki.datarealms.com/Scene:GetArea"
Personal tools