Browse Source

Travis CI: API documentation update at 2014-01-01 10:34:53 UTC.
[ci skip]

urho3d-travis-ci 12 years ago
parent
commit
0c6c107935
3 changed files with 148 additions and 89 deletions
  1. 24 2
      Docs/AngelScriptAPI.h
  2. 101 85
      Docs/LuaScriptAPI.dox
  3. 23 2
      Docs/ScriptAPI.dox

+ 24 - 2
Docs/AngelScriptAPI.h

@@ -1784,7 +1784,7 @@ void Roll(float, bool = false);
 void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
 void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
 void Scale(float);
 void Scale(float);
 void Scale(const Vector3&);
 void Scale(const Vector3&);
-Node CreateChild(const String& = "", CreateMode = REPLICATED, uint = 0);
+Node CreateChild(const String& = String ( ), CreateMode = REPLICATED, uint = 0);
 void AddChild(Node);
 void AddChild(Node);
 void RemoveChild(Node);
 void RemoveChild(Node);
 void RemoveAllChildren();
 void RemoveAllChildren();
@@ -1959,7 +1959,7 @@ void Roll(float, bool = false);
 void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
 void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
 void Scale(float);
 void Scale(float);
 void Scale(const Vector3&);
 void Scale(const Vector3&);
-Node CreateChild(const String& = "", CreateMode = REPLICATED, uint = 0);
+Node CreateChild(const String& = String ( ), CreateMode = REPLICATED, uint = 0);
 void AddChild(Node);
 void AddChild(Node);
 void RemoveChild(Node);
 void RemoveChild(Node);
 void RemoveAllChildren();
 void RemoveAllChildren();
@@ -6765,6 +6765,28 @@ int acceleratorKey;
 int acceleratorQualifiers;
 int acceleratorQualifiers;
 };
 };
 
 
+class MessageBox
+{
+// Methods:
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+
+// Properties:
+/* (readonly) */
+int refs;
+/* (readonly) */
+int weakRefs;
+/* (readonly) */
+ShortStringHash type;
+/* (readonly) */
+ShortStringHash baseType;
+/* (readonly) */
+String typeName;
+/* (readonly) */
+String category;
+String title;
+String message;
+};
+
 class DropDownList
 class DropDownList
 {
 {
 // Methods:
 // Methods:

+ 101 - 85
Docs/LuaScriptAPI.dox

@@ -1804,83 +1804,6 @@ Properties:
 - bool override
 - bool override
 - bool ambientGradient
 - bool ambientGradient
 
 
-### TouchState
-
-Methods:
-
-
-Properties:
-
-- int touchID
-- IntVector2 position
-- IntVector2 lastPosition
-- IntVector2 delta
-- float pressure
-
-### JoystickState
-
-Methods:
-
-- unsigned GetNumButtons() const
-- unsigned GetNumAxes() const
-- unsigned GetNumHats() const
-- bool GetButtonDown(unsigned index) const
-- bool GetButtonPress(unsigned index) const
-- float GetAxisPosition(unsigned index) const
-- int GetHatPosition(unsigned index) const
-
-Properties:
-
-- unsigned numButtons (readonly)
-- unsigned numAxes (readonly)
-- unsigned numHats (readonly)
-
-### Input : Object
-
-Methods:
-
-- void SetToggleFullscreen(bool enable)
-- void SetMouseVisible(bool enable)
-- bool OpenJoystick(unsigned index)
-- void CloseJoystick(unsigned index)
-- bool DetectJoysticks()
-- bool GetKeyDown(int key) const
-- bool GetKeyPress(int key) const
-- bool GetMouseButtonDown(int button) const
-- bool GetMouseButtonPress(int button) const
-- bool GetQualifierDown(int qualifier) const
-- bool GetQualifierPress(int qualifier) const
-- int GetQualifiers() const
-- IntVector2 GetMousePosition() const
-- const IntVector2& GetMouseMove() const
-- int GetMouseMoveX() const
-- int GetMouseMoveY() const
-- int GetMouseMoveWheel() const
-- unsigned GetNumTouches() const
-- TouchState* GetTouch(unsigned index) const
-- unsigned GetNumJoysticks() const
-- const String GetJoystickName(unsigned index) const
-- JoystickState* GetJoystick(unsigned index)
-- bool GetToggleFullscreen() const
-- bool IsMouseVisible() const
-- bool HasFocus()
-- bool IsMinimized() const
-
-Properties:
-
-- int qualifiers (readonly)
-- IntVector2 mousePosition (readonly)
-- IntVector2& mouseMove (readonly)
-- int mouseMoveX (readonly)
-- int mouseMoveY (readonly)
-- int mouseMoveWheel (readonly)
-- unsigned numTouches (readonly)
-- unsigned numJoysticks (readonly)
-- bool toggleFullscreen (readonly)
-- bool mouseVisible
-- bool focus (readonly)
-- bool minimized (readonly)
-
 ### Deserializer
 ### Deserializer
 
 
 Methods:
 Methods:
@@ -2263,6 +2186,83 @@ Properties:
 - unsigned size (readonly)
 - unsigned size (readonly)
 - bool eof (readonly)
 - bool eof (readonly)
 
 
+### TouchState
+
+Methods:
+
+
+Properties:
+
+- int touchID
+- IntVector2 position
+- IntVector2 lastPosition
+- IntVector2 delta
+- float pressure
+
+### JoystickState
+
+Methods:
+
+- unsigned GetNumButtons() const
+- unsigned GetNumAxes() const
+- unsigned GetNumHats() const
+- bool GetButtonDown(unsigned index) const
+- bool GetButtonPress(unsigned index) const
+- float GetAxisPosition(unsigned index) const
+- int GetHatPosition(unsigned index) const
+
+Properties:
+
+- unsigned numButtons (readonly)
+- unsigned numAxes (readonly)
+- unsigned numHats (readonly)
+
+### Input : Object
+
+Methods:
+
+- void SetToggleFullscreen(bool enable)
+- void SetMouseVisible(bool enable)
+- bool OpenJoystick(unsigned index)
+- void CloseJoystick(unsigned index)
+- bool DetectJoysticks()
+- bool GetKeyDown(int key) const
+- bool GetKeyPress(int key) const
+- bool GetMouseButtonDown(int button) const
+- bool GetMouseButtonPress(int button) const
+- bool GetQualifierDown(int qualifier) const
+- bool GetQualifierPress(int qualifier) const
+- int GetQualifiers() const
+- IntVector2 GetMousePosition() const
+- const IntVector2& GetMouseMove() const
+- int GetMouseMoveX() const
+- int GetMouseMoveY() const
+- int GetMouseMoveWheel() const
+- unsigned GetNumTouches() const
+- TouchState* GetTouch(unsigned index) const
+- unsigned GetNumJoysticks() const
+- const String GetJoystickName(unsigned index) const
+- JoystickState* GetJoystick(unsigned index)
+- bool GetToggleFullscreen() const
+- bool IsMouseVisible() const
+- bool HasFocus()
+- bool IsMinimized() const
+
+Properties:
+
+- int qualifiers (readonly)
+- IntVector2 mousePosition (readonly)
+- IntVector2& mouseMove (readonly)
+- int mouseMoveX (readonly)
+- int mouseMoveY (readonly)
+- int mouseMoveWheel (readonly)
+- unsigned numTouches (readonly)
+- unsigned numJoysticks (readonly)
+- bool toggleFullscreen (readonly)
+- bool mouseVisible
+- bool focus (readonly)
+- bool minimized (readonly)
+
 ### LuaScriptInstance : Component
 ### LuaScriptInstance : Component
 
 
 Methods:
 Methods:
@@ -4325,6 +4325,22 @@ Properties:
 - int acceleratorKey (readonly)
 - int acceleratorKey (readonly)
 - int acceleratorQualifiers (readonly)
 - int acceleratorQualifiers (readonly)
 
 
+### MessageBox : Object
+
+Methods:
+
+- MessageBox(Context* context, const String& messageString = String::EMPTY, const String& titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
+- virtual ~MessageBox()
+- void SetTitle(const String& text)
+- void SetMessage(const String& text)
+- const String GetTitle() const
+- const String GetMessage() const
+
+Properties:
+
+- String& title
+- String& message
+
 ### DropDownList : Menu
 ### DropDownList : Menu
 
 
 Methods:
 Methods:
@@ -4930,6 +4946,14 @@ Properties:
 - unsigned VO_DISABLE_OCCLUSION
 - unsigned VO_DISABLE_OCCLUSION
 - int SHADOW_MIN_PIXELS
 - int SHADOW_MIN_PIXELS
 - int INSTANCING_BUFFER_DEFAULT_SIZE
 - int INSTANCING_BUFFER_DEFAULT_SIZE
+- unsigned SCAN_FILES
+- unsigned SCAN_DIRS
+- unsigned SCAN_HIDDEN
+- int LOG_DEBUG
+- int LOG_INFO
+- int LOG_WARNING
+- int LOG_ERROR
+- int LOG_NONE
 - int MOUSEB_LEFT
 - int MOUSEB_LEFT
 - int MOUSEB_MIDDLE
 - int MOUSEB_MIDDLE
 - int MOUSEB_RIGHT
 - int MOUSEB_RIGHT
@@ -5052,14 +5076,6 @@ Properties:
 - int HAT_RIGHT
 - int HAT_RIGHT
 - int HAT_DOWN
 - int HAT_DOWN
 - int HAT_LEFT
 - int HAT_LEFT
-- unsigned SCAN_FILES
-- unsigned SCAN_DIRS
-- unsigned SCAN_HIDDEN
-- int LOG_DEBUG
-- int LOG_INFO
-- int LOG_WARNING
-- int LOG_ERROR
-- int LOG_NONE
 - float M_PI
 - float M_PI
 - int M_MIN_INT
 - int M_MIN_INT
 - int M_MAX_INT
 - int M_MAX_INT

+ 23 - 2
Docs/ScriptAPI.dox

@@ -1675,7 +1675,7 @@ Methods:
 - void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
 - void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
 - void Scale(float)
 - void Scale(float)
 - void Scale(const Vector3&)
 - void Scale(const Vector3&)
-- Node@ CreateChild(const String& = "", CreateMode = REPLICATED, uint = 0)
+- Node@ CreateChild(const String& = String ( ), CreateMode = REPLICATED, uint = 0)
 - void AddChild(Node@)
 - void AddChild(Node@)
 - void RemoveChild(Node@)
 - void RemoveChild(Node@)
 - void RemoveAllChildren()
 - void RemoveAllChildren()
@@ -1821,7 +1821,7 @@ Methods:
 - void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
 - void LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
 - void Scale(float)
 - void Scale(float)
 - void Scale(const Vector3&)
 - void Scale(const Vector3&)
-- Node@ CreateChild(const String& = "", CreateMode = REPLICATED, uint = 0)
+- Node@ CreateChild(const String& = String ( ), CreateMode = REPLICATED, uint = 0)
 - void AddChild(Node@)
 - void AddChild(Node@)
 - void RemoveChild(Node@)
 - void RemoveChild(Node@)
 - void RemoveAllChildren()
 - void RemoveAllChildren()
@@ -5770,6 +5770,24 @@ Properties:
 - int acceleratorQualifiers (readonly)
 - int acceleratorQualifiers (readonly)
 
 
 
 
+### MessageBox
+
+Methods:
+
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+
+Properties:
+
+- int refs (readonly)
+- int weakRefs (readonly)
+- ShortStringHash type (readonly)
+- ShortStringHash baseType (readonly)
+- String typeName (readonly)
+- String category (readonly)
+- String title
+- String message
+
+
 ### DropDownList
 ### DropDownList
 
 
 Methods:
 Methods:
@@ -7933,6 +7951,9 @@ Properties:
 - %Filter : String
 - %Filter : String
 - %Ok : bool
 - %Ok : bool
 
 
+### MessageACK
+- %Ok : bool
+
 ### ElementAdded
 ### ElementAdded
 - %Root : UIElement pointer
 - %Root : UIElement pointer
 - %Parent : UIElement pointer
 - %Parent : UIElement pointer