浏览代码

Travis CI: API documentation update at 2014-03-14 11:42:25 UTC.
[ci package]

urho3d-travis-ci 11 年之前
父节点
当前提交
f6cd0f07d7
共有 3 个文件被更改,包括 303 次插入26 次删除
  1. 137 3
      Docs/AngelScriptAPI.h
  2. 56 20
      Docs/LuaScriptAPI.dox
  3. 110 3
      Docs/ScriptAPI.dox

+ 137 - 3
Docs/AngelScriptAPI.h

@@ -1187,6 +1187,136 @@ int weakRefs;
 int width;
 int width;
 };
 };
 
 
+class CollisionBox2D
+{
+// Methods:
+void ApplyAttributes();
+void DrawDebugGeometry(DebugRenderer, bool);
+Variant GetAttribute(const String&) const;
+Variant GetAttributeDefault(const String&) const;
+bool Load(File, bool = false);
+bool LoadXML(const XMLElement&, bool = false);
+void MarkNetworkUpdate() const;
+void Remove();
+void RemoveInstanceDefault();
+void ResetToDefault();
+bool Save(File) const;
+bool SaveXML(XMLElement&) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetAttribute(const String&, const Variant&);
+void SetCenter(float, float);
+void SetSize(float, float);
+
+// Properties:
+float angle;
+/* readonly */
+Array<Variant> attributeDefaults;
+/* readonly */
+Array<AttributeInfo> attributeInfos;
+Array<Variant> attributes;
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+int categoryBits;
+Vector2 center;
+float density;
+bool enabled;
+/* readonly */
+bool enabledEffective;
+float friction;
+int groupIndex;
+/* readonly */
+uint id;
+/* readonly */
+float inertia;
+int maskBits;
+/* readonly */
+float mass;
+/* readonly */
+Vector2 massCenter;
+/* readonly */
+Node node;
+/* readonly */
+uint numAttributes;
+/* readonly */
+int refs;
+float restitution;
+bool sensor;
+Vector2 size;
+bool temporary;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+int weakRefs;
+};
+
+class CollisionCircle2D
+{
+// Methods:
+void ApplyAttributes();
+void DrawDebugGeometry(DebugRenderer, bool);
+Variant GetAttribute(const String&) const;
+Variant GetAttributeDefault(const String&) const;
+bool Load(File, bool = false);
+bool LoadXML(const XMLElement&, bool = false);
+void MarkNetworkUpdate() const;
+void Remove();
+void RemoveInstanceDefault();
+void ResetToDefault();
+bool Save(File) const;
+bool SaveXML(XMLElement&) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetAttribute(const String&, const Variant&);
+void SetCenter(float, float);
+
+// Properties:
+/* readonly */
+Array<Variant> attributeDefaults;
+/* readonly */
+Array<AttributeInfo> attributeInfos;
+Array<Variant> attributes;
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+int categoryBits;
+Vector2 center;
+float density;
+bool enabled;
+/* readonly */
+bool enabledEffective;
+float friction;
+int groupIndex;
+/* readonly */
+uint id;
+/* readonly */
+float inertia;
+int maskBits;
+/* readonly */
+float mass;
+/* readonly */
+Vector2 massCenter;
+/* readonly */
+Node node;
+/* readonly */
+uint numAttributes;
+float radius;
+/* readonly */
+int refs;
+float restitution;
+bool sensor;
+bool temporary;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+int weakRefs;
+};
+
 class CollisionShape
 class CollisionShape
 {
 {
 // Methods:
 // Methods:
@@ -1283,18 +1413,18 @@ Array<Variant> attributes;
 ShortStringHash baseType;
 ShortStringHash baseType;
 /* readonly */
 /* readonly */
 String category;
 String category;
-uint16 categoryBits;
+int categoryBits;
 float density;
 float density;
 bool enabled;
 bool enabled;
 /* readonly */
 /* readonly */
 bool enabledEffective;
 bool enabledEffective;
 float friction;
 float friction;
-int16 groupIndex;
+int groupIndex;
 /* readonly */
 /* readonly */
 uint id;
 uint id;
 /* readonly */
 /* readonly */
 float inertia;
 float inertia;
-uint16 maskBits;
+int maskBits;
 /* readonly */
 /* readonly */
 float mass;
 float mass;
 /* readonly */
 /* readonly */
@@ -4684,6 +4814,7 @@ class PhysicsWorld2D
 {
 {
 // Methods:
 // Methods:
 void ApplyAttributes();
 void ApplyAttributes();
+void DrawDebugGeometry() const;
 void DrawDebugGeometry(DebugRenderer, bool);
 void DrawDebugGeometry(DebugRenderer, bool);
 Variant GetAttribute(const String&) const;
 Variant GetAttribute(const String&) const;
 Variant GetAttributeDefault(const String&) const;
 Variant GetAttributeDefault(const String&) const;
@@ -5438,6 +5569,8 @@ Octree octree;
 Node parent;
 Node parent;
 /* readonly */
 /* readonly */
 PhysicsWorld physicsWorld;
 PhysicsWorld physicsWorld;
+/* readonly */
+PhysicsWorld2D physicsWorld2D;
 Vector3 position;
 Vector3 position;
 /* readonly */
 /* readonly */
 int refs;
 int refs;
@@ -9519,6 +9652,7 @@ Network network;
 Node node;
 Node node;
 Octree octree;
 Octree octree;
 PhysicsWorld physicsWorld;
 PhysicsWorld physicsWorld;
+PhysicsWorld2D physicsWorld2D;
 Renderer renderer;
 Renderer renderer;
 ResourceCache resourceCache;
 ResourceCache resourceCache;
 Scene scene;
 Scene scene;

+ 56 - 20
Docs/LuaScriptAPI.dox

@@ -559,6 +559,40 @@ Properties:
 - bool checked
 - bool checked
 - IntVector2& checkedOffset
 - IntVector2& checkedOffset
 
 
+### CollisionBox2D : CollisionShape2D
+
+Methods:
+
+- void SetSize(const Vector2& size)
+- void SetSize(float width, float height)
+- void SetCenter(const Vector2& center)
+- void SetCenter(float x, float y)
+- void SetAngle(float angle)
+- const Vector2& GetSize() const
+- const Vector2& GetCenter() const
+- float GetAngle() const
+
+Properties:
+
+- Vector2& size
+- Vector2& center
+- float angle
+
+### CollisionCircle2D : CollisionShape2D
+
+Methods:
+
+- void SetRadius(float radius)
+- void SetCenter(const Vector2& center)
+- void SetCenter(float x, float y)
+- float GetRadius() const
+- const Vector2& GetCenter() const
+
+Properties:
+
+- float radius
+- Vector2& center
+
 ### CollisionShape : Component
 ### CollisionShape : Component
 
 
 Methods:
 Methods:
@@ -626,16 +660,16 @@ Properties:
 Methods:
 Methods:
 
 
 - void SetSensor(bool sensor)
 - void SetSensor(bool sensor)
-- void SetCategoryBits(short categoryBits)
-- void SetMaskBits(short maskBits)
-- void SetGroupIndex(short groupIndex)
+- void SetCategoryBits(int categoryBits)
+- void SetMaskBits(int maskBits)
+- void SetGroupIndex(int groupIndex)
 - void SetDensity(float density)
 - void SetDensity(float density)
 - void SetFriction(float friction)
 - void SetFriction(float friction)
 - void SetRestitution(float restitution)
 - void SetRestitution(float restitution)
 - bool IsSensor() const
 - bool IsSensor() const
-- short GetCategoryBits() const
-- short GetMaskBits() const
-- short GetGroupIndex() const
+- int GetCategoryBits() const
+- int GetMaskBits() const
+- int GetGroupIndex() const
 - float GetDensity() const
 - float GetDensity() const
 - float GetFriction() const
 - float GetFriction() const
 - float GetRestitution() const
 - float GetRestitution() const
@@ -646,9 +680,9 @@ Methods:
 Properties:
 Properties:
 
 
 - bool sensor
 - bool sensor
-- short categoryBits
-- short maskBits
-- short groupIndex
+- int categoryBits
+- int maskBits
+- int groupIndex
 - float density
 - float density
 - float friction
 - float friction
 - float restitution
 - float restitution
@@ -2827,10 +2861,10 @@ Methods:
 - void SetWarmStarting(bool enable)
 - void SetWarmStarting(bool enable)
 - void SetContinuousPhysics(bool enable)
 - void SetContinuousPhysics(bool enable)
 - void SetSubStepping(bool enable)
 - void SetSubStepping(bool enable)
-- void SetGravity(Vector2 gravity)
+- void SetGravity(const Vector2& gravity)
 - void SetAutoClearForces(bool enable)
 - void SetAutoClearForces(bool enable)
-- void SetVelocityIterations(unsigned velocityIterations)
-- void SetPositionIterations(unsigned positionIterations)
+- void SetVelocityIterations(int velocityIterations)
+- void SetPositionIterations(int positionIterations)
 - void DrawDebugGeometry()
 - void DrawDebugGeometry()
 - bool GetDrawShape() const
 - bool GetDrawShape() const
 - bool GetDrawJoint() const
 - bool GetDrawJoint() const
@@ -2842,9 +2876,9 @@ Methods:
 - bool GetContinuousPhysics() const
 - bool GetContinuousPhysics() const
 - bool GetSubStepping() const
 - bool GetSubStepping() const
 - bool GetAutoClearForces() const
 - bool GetAutoClearForces() const
-- Vector2 GetGravity() const
-- unsigned GetVelocityIterations() const
-- unsigned GetPositionIterations() const
+- const Vector2& GetGravity() const
+- int GetVelocityIterations() const
+- int GetPositionIterations() const
 
 
 Properties:
 Properties:
 
 
@@ -2858,9 +2892,9 @@ Properties:
 - bool continuousPhysics
 - bool continuousPhysics
 - bool subStepping
 - bool subStepping
 - bool autoClearForces
 - bool autoClearForces
-- Vector2 gravity
-- unsigned velocityIterations
-- unsigned positionIterations
+- Vector2& gravity
+- int velocityIterations
+- int positionIterations
 
 
 ### Plane
 ### Plane
 
 
@@ -3452,7 +3486,7 @@ Methods:
 - void SetBodyType(BodyType2D bodyType)
 - void SetBodyType(BodyType2D bodyType)
 - void SetMass(float mass)
 - void SetMass(float mass)
 - void SetInertia(float inertia)
 - void SetInertia(float inertia)
-- void SetMassCenter(const Vector2& center)
+- void SetMassCenter(Vector2 center)
 - void SetUseFixtureMass(bool useFixtureMass)
 - void SetUseFixtureMass(bool useFixtureMass)
 - void SetLinearDamping(float linearDamping)
 - void SetLinearDamping(float linearDamping)
 - void SetAngularDamping(float angularDamping)
 - void SetAngularDamping(float angularDamping)
@@ -3461,7 +3495,7 @@ Methods:
 - void SetBullet(bool bullet)
 - void SetBullet(bool bullet)
 - void SetGravityScale(float gravityScale)
 - void SetGravityScale(float gravityScale)
 - void SetAwake(bool awake)
 - void SetAwake(bool awake)
-- void SetLinearVelocity(const Vector2& linearVelocity)
+- void SetLinearVelocity(Vector2 linearVelocity)
 - void SetAngularVelocity(float angularVelocity)
 - void SetAngularVelocity(float angularVelocity)
 - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
 - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
 - void ApplyForceToCenter(const Vector2& force, bool wake)
 - void ApplyForceToCenter(const Vector2& force, bool wake)
@@ -3481,6 +3515,7 @@ Methods:
 - float GetGravityScale() const
 - float GetGravityScale() const
 - bool IsAwake() const
 - bool IsAwake() const
 - Vector2 GetLinearVelocity() const
 - Vector2 GetLinearVelocity() const
+- float GetAngularVelocity() const
 
 
 Properties:
 Properties:
 
 
@@ -3497,6 +3532,7 @@ Properties:
 - float gravityScale
 - float gravityScale
 - bool awake
 - bool awake
 - Vector2 linearVelocity
 - Vector2 linearVelocity
+- float angularVelocity
 
 
 ### Scene : Node
 ### Scene : Node
 
 

+ 110 - 3
Docs/ScriptAPI.dox

@@ -1004,6 +1004,110 @@ Properties:
 - int width
 - int width
 
 
 
 
+### CollisionBox2D
+
+Methods:
+
+- void ApplyAttributes()
+- void DrawDebugGeometry(DebugRenderer@, bool)
+- Variant GetAttribute(const String&) const
+- Variant GetAttributeDefault(const String&) const
+- bool Load(File@, bool = false)
+- bool LoadXML(const XMLElement&, bool = false)
+- void MarkNetworkUpdate() const
+- void Remove()
+- void RemoveInstanceDefault()
+- void ResetToDefault()
+- bool Save(File@) const
+- bool SaveXML(XMLElement&) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetAttribute(const String&, const Variant&)
+- void SetCenter(float, float)
+- void SetSize(float, float)
+
+Properties:
+
+- float angle
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- String category // readonly
+- int categoryBits
+- Vector2 center
+- float density
+- bool enabled
+- bool enabledEffective // readonly
+- float friction
+- int groupIndex
+- uint id // readonly
+- float inertia // readonly
+- int maskBits
+- float mass // readonly
+- Vector2 massCenter // readonly
+- Node@ node // readonly
+- uint numAttributes // readonly
+- int refs // readonly
+- float restitution
+- bool sensor
+- Vector2 size
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- int weakRefs // readonly
+
+
+### CollisionCircle2D
+
+Methods:
+
+- void ApplyAttributes()
+- void DrawDebugGeometry(DebugRenderer@, bool)
+- Variant GetAttribute(const String&) const
+- Variant GetAttributeDefault(const String&) const
+- bool Load(File@, bool = false)
+- bool LoadXML(const XMLElement&, bool = false)
+- void MarkNetworkUpdate() const
+- void Remove()
+- void RemoveInstanceDefault()
+- void ResetToDefault()
+- bool Save(File@) const
+- bool SaveXML(XMLElement&) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetAttribute(const String&, const Variant&)
+- void SetCenter(float, float)
+
+Properties:
+
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- String category // readonly
+- int categoryBits
+- Vector2 center
+- float density
+- bool enabled
+- bool enabledEffective // readonly
+- float friction
+- int groupIndex
+- uint id // readonly
+- float inertia // readonly
+- int maskBits
+- float mass // readonly
+- Vector2 massCenter // readonly
+- Node@ node // readonly
+- uint numAttributes // readonly
+- float radius
+- int refs // readonly
+- float restitution
+- bool sensor
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- int weakRefs // readonly
+
+
 ### CollisionShape
 ### CollisionShape
 
 
 Methods:
 Methods:
@@ -1087,15 +1191,15 @@ Properties:
 - Variant[] attributes
 - Variant[] attributes
 - ShortStringHash baseType // readonly
 - ShortStringHash baseType // readonly
 - String category // readonly
 - String category // readonly
-- uint16 categoryBits
+- int categoryBits
 - float density
 - float density
 - bool enabled
 - bool enabled
 - bool enabledEffective // readonly
 - bool enabledEffective // readonly
 - float friction
 - float friction
-- int16 groupIndex
+- int groupIndex
 - uint id // readonly
 - uint id // readonly
 - float inertia // readonly
 - float inertia // readonly
-- uint16 maskBits
+- int maskBits
 - float mass // readonly
 - float mass // readonly
 - Vector2 massCenter // readonly
 - Vector2 massCenter // readonly
 - Node@ node // readonly
 - Node@ node // readonly
@@ -3901,6 +4005,7 @@ Properties:
 Methods:
 Methods:
 
 
 - void ApplyAttributes()
 - void ApplyAttributes()
+- void DrawDebugGeometry() const
 - void DrawDebugGeometry(DebugRenderer@, bool)
 - void DrawDebugGeometry(DebugRenderer@, bool)
 - Variant GetAttribute(const String&) const
 - Variant GetAttribute(const String&) const
 - Variant GetAttributeDefault(const String&) const
 - Variant GetAttributeDefault(const String&) const
@@ -4568,6 +4673,7 @@ Properties:
 - Octree@ octree // readonly
 - Octree@ octree // readonly
 - Node@ parent
 - Node@ parent
 - PhysicsWorld@ physicsWorld // readonly
 - PhysicsWorld@ physicsWorld // readonly
+- PhysicsWorld2D@ physicsWorld2D // readonly
 - Vector3 position
 - Vector3 position
 - int refs // readonly
 - int refs // readonly
 - PackageFile@[]@ requiredPackageFiles // readonly
 - PackageFile@[]@ requiredPackageFiles // readonly
@@ -8053,6 +8159,7 @@ Properties:
 - Node@ node
 - Node@ node
 - Octree@ octree
 - Octree@ octree
 - PhysicsWorld@ physicsWorld
 - PhysicsWorld@ physicsWorld
+- PhysicsWorld2D@ physicsWorld2D
 - Renderer@ renderer
 - Renderer@ renderer
 - ResourceCache@ resourceCache
 - ResourceCache@ resourceCache
 - Scene@ scene
 - Scene@ scene