Browse Source

Travis CI: API documentation update at 2014-02-27 16:14:04 UTC.
[ci package]

urho3d-travis-ci 11 years ago
parent
commit
927a652c74
3 changed files with 658 additions and 0 deletions
  1. 313 0
      Docs/AngelScriptAPI.h
  2. 90 0
      Docs/LuaScriptAPI.dox
  3. 255 0
      Docs/ScriptAPI.dox

+ 313 - 0
Docs/AngelScriptAPI.h

@@ -1950,6 +1950,77 @@ BoundingBox worldBoundingBox;
 uint zoneMask;
 };
 
+class Drawable2D
+{
+// Methods:
+void ApplyAttributes();
+void DrawDebugGeometry(DebugRenderer, bool);
+Variant GetAttribute(const String&) const;
+Variant GetAttributeDefault(const String&) const;
+bool IsInView(Camera) 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&);
+
+// Properties:
+/* readonly */
+Array<Variant> attributeDefaults;
+/* readonly */
+Array<AttributeInfo> attributeInfos;
+Array<Variant> attributes;
+/* readonly */
+ShortStringHash baseType;
+BlendMode blendMode;
+/* readonly */
+BoundingBox boundingBox;
+bool castShadows;
+/* readonly */
+String category;
+float drawDistance;
+bool enabled;
+/* readonly */
+bool enabledEffective;
+/* readonly */
+uint id;
+/* readonly */
+bool inView;
+uint lightMask;
+float lodBias;
+Material material;
+uint maxLights;
+/* readonly */
+Node node;
+/* readonly */
+uint numAttributes;
+bool occludee;
+bool occluder;
+/* readonly */
+int refs;
+float shadowDistance;
+uint shadowMask;
+Sprite2D sprite;
+bool temporary;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+float unitPerPixel;
+uint viewMask;
+/* readonly */
+int weakRefs;
+/* readonly */
+BoundingBox worldBoundingBox;
+float zValue;
+uint zoneMask;
+};
+
 class DropDownList
 {
 // Methods:
@@ -4237,6 +4308,105 @@ Zone zone;
 uint zoneMask;
 };
 
+class ParticleEmitter2D
+{
+// Methods:
+void ApplyAttributes();
+void DrawDebugGeometry(DebugRenderer, bool);
+Variant GetAttribute(const String&) const;
+Variant GetAttributeDefault(const String&) const;
+bool IsInView(Camera) 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&);
+
+// Properties:
+/* readonly */
+Array<Variant> attributeDefaults;
+/* readonly */
+Array<AttributeInfo> attributeInfos;
+Array<Variant> attributes;
+/* readonly */
+ShortStringHash baseType;
+BlendMode blendMode;
+/* readonly */
+BoundingBox boundingBox;
+bool castShadows;
+/* readonly */
+String category;
+float drawDistance;
+bool enabled;
+/* readonly */
+bool enabledEffective;
+/* readonly */
+uint id;
+/* readonly */
+bool inView;
+uint lightMask;
+float lodBias;
+Material material;
+uint maxLights;
+ParticleModel2D model;
+/* readonly */
+Node node;
+/* readonly */
+uint numAttributes;
+bool occludee;
+bool occluder;
+/* readonly */
+int refs;
+float shadowDistance;
+uint shadowMask;
+Sprite2D sprite;
+bool temporary;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+float unitPerPixel;
+uint viewMask;
+/* readonly */
+int weakRefs;
+/* readonly */
+BoundingBox worldBoundingBox;
+float zValue;
+uint zoneMask;
+};
+
+class ParticleModel2D
+{
+// Methods:
+bool Load(File);
+bool Save(File) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+
+// Properties:
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+/* readonly */
+uint memoryUse;
+String name;
+/* readonly */
+int refs;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+uint useTimer;
+/* readonly */
+int weakRefs;
+};
+
 class Pass
 {
 
@@ -6269,6 +6439,68 @@ int weakRefs;
 int width;
 };
 
+class Sprite2D
+{
+// Methods:
+bool Load(File);
+bool Save(File) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+
+// Properties:
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+Vector2 hotSpot;
+/* readonly */
+uint memoryUse;
+String name;
+IntRect rectangle;
+/* readonly */
+int refs;
+Texture2D texture;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+uint useTimer;
+/* readonly */
+int weakRefs;
+};
+
+class SpriteSheet2D
+{
+// Methods:
+void DefineSprite(const String&, const IntRect&, const Vector2&);
+Sprite2D GetSprite(const String&);
+bool Load(File);
+bool Save(File) const;
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+void UpdateSprite(const String&, const IntRect&, const Vector2&);
+
+// Properties:
+/* readonly */
+ShortStringHash baseType;
+/* readonly */
+String category;
+/* readonly */
+uint memoryUse;
+String name;
+/* readonly */
+int refs;
+/* readonly */
+Texture2D texture;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+uint useTimer;
+/* readonly */
+int weakRefs;
+};
+
 class StaticModel
 {
 // Methods:
@@ -6428,6 +6660,81 @@ Zone zone;
 uint zoneMask;
 };
 
+class StaticSprite2D
+{
+// Methods:
+void ApplyAttributes();
+void DrawDebugGeometry(DebugRenderer, bool);
+Variant GetAttribute(const String&) const;
+Variant GetAttributeDefault(const String&) const;
+bool IsInView(Camera) 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 SetFlip(bool, bool);
+
+// Properties:
+/* readonly */
+Array<Variant> attributeDefaults;
+/* readonly */
+Array<AttributeInfo> attributeInfos;
+Array<Variant> attributes;
+/* readonly */
+ShortStringHash baseType;
+BlendMode blendMode;
+/* readonly */
+BoundingBox boundingBox;
+bool castShadows;
+/* readonly */
+String category;
+Color color;
+float drawDistance;
+bool enabled;
+/* readonly */
+bool enabledEffective;
+bool flipX;
+bool flipY;
+/* readonly */
+uint id;
+/* readonly */
+bool inView;
+uint lightMask;
+float lodBias;
+Material material;
+uint maxLights;
+/* readonly */
+Node node;
+/* readonly */
+uint numAttributes;
+bool occludee;
+bool occluder;
+/* readonly */
+int refs;
+float shadowDistance;
+uint shadowMask;
+Sprite2D sprite;
+bool temporary;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+float unitPerPixel;
+uint viewMask;
+/* readonly */
+int weakRefs;
+/* readonly */
+BoundingBox worldBoundingBox;
+float zValue;
+uint zoneMask;
+};
+
 class String
 {
 // Methods:
@@ -8503,6 +8810,12 @@ EMITTER_SPHERE,
 EMITTER_BOX,
 };
 
+enum EmitterType2D
+{
+EMITTER_TYPE_GRAVITY,
+EMITTER_TYPE_RADIAL,
+};
+
 enum FileMode
 {
 FILE_READ,

+ 90 - 0
Docs/LuaScriptAPI.dox

@@ -1064,6 +1064,29 @@ Properties:
 - bool inView (readonly)
 - Zone* zone (readonly)
 
+### Drawable2D : Drawable
+
+Methods:
+
+- void SetUnitPerPixel(float unitPerPixel)
+- void SetSprite(Sprite2D* sprite)
+- void SetMaterial(Material* material)
+- void SetBlendMode(BlendMode mode)
+- void SetZValue(float zValue)
+- float GetUnitPerPixel() const
+- Sprite2D* GetSprite() const
+- Material* GetMaterial() const
+- BlendMode GetBlendMode() const
+- float GetZValue() const
+
+Properties:
+
+- float unitPerPixel
+- Sprite2D* sprite
+- Material* material
+- BlendMode blendMode
+- float zValue
+
 ### DropDownList : Menu
 
 Methods:
@@ -2644,6 +2667,19 @@ Properties:
 - unsigned numColors
 - unsigned numTextureFrames
 
+### ParticleEmitter2D : Drawable2D
+
+Methods:
+
+- void SetModel(ParticleModel2D* model)
+- ParticleModel2D* GetModel() const
+
+Properties:
+
+- ParticleModel2D* model
+
+### ParticleModel2D : Resource
+
 ### Pass : RefCounted
 
 ### PhysicsRaycastResult
@@ -3759,6 +3795,37 @@ Properties:
 - BlendMode blendMode
 - Matrix3x4& transform (readonly)
 
+### Sprite2D : Resource
+
+Methods:
+
+- void SetTexture(Texture2D* texture)
+- void SetRectangle(const IntRect& rectangle)
+- void SetHotSpot(const Vector2& hotSpot)
+- void SetSpriteSheet(SpriteSheet2D* spriteSheet)
+- Texture2D* GetTexture() const
+- const IntRect& GetRectangle() const
+- const Vector2& GetHotSpot() const
+- SpriteSheet2D* GetSpriteSheet() const
+
+Properties:
+
+- Texture2D* texture
+- IntRect rectangle
+- Vector2 hotSpot
+- SpriteSheet2D* spriteSheet
+
+### SpriteSheet2D : Resource
+
+Methods:
+
+- Texture2D* GetTexture() const
+- Sprite2D* GetSprite(const String name) const
+- void DefineSprite(const String name, const IntRect& rectangle)
+- void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
+- void UpdateSprite(const String name, const IntRect& rectangle)
+- void UpdateSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
+
 ### StaticModel : Drawable
 
 Methods:
@@ -3805,6 +3872,24 @@ Properties:
 
 - unsigned numInstanceNodes (readonly)
 
+### StaticSprite2D : Drawable2D
+
+Methods:
+
+- void SetFlip(bool flipX, bool flipY)
+- void SetFlipX(bool flipX)
+- void SetFlipY(bool flipY)
+- void SetColor(const Color& color)
+- bool GetFlipX() const
+- bool GetFlipY() const
+- const Color& GetColor() const
+
+Properties:
+
+- bool flipX
+- bool flipY
+- Color& color
+
 ### StringHash
 
 
@@ -5225,6 +5310,11 @@ Properties:
 - int EMITTER_SPHERE
 - int EMITTER_BOX
 
+### EmitterType2D
+
+- int EMITTER_TYPE_GRAVITY
+- int EMITTER_TYPE_RADIAL
+
 ### FileMode
 
 - int FILE_READ

+ 255 - 0
Docs/ScriptAPI.dox

@@ -1645,6 +1645,64 @@ Properties:
 - uint zoneMask
 
 
+### Drawable2D
+
+Methods:
+
+- void ApplyAttributes()
+- void DrawDebugGeometry(DebugRenderer@, bool)
+- Variant GetAttribute(const String&) const
+- Variant GetAttributeDefault(const String&) const
+- bool IsInView(Camera@) 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&)
+
+Properties:
+
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- BlendMode blendMode
+- BoundingBox boundingBox // readonly
+- bool castShadows
+- String category // readonly
+- float drawDistance
+- bool enabled
+- bool enabledEffective // readonly
+- uint id // readonly
+- bool inView // readonly
+- uint lightMask
+- float lodBias
+- Material@ material
+- uint maxLights
+- Node@ node // readonly
+- uint numAttributes // readonly
+- bool occludee
+- bool occluder
+- int refs // readonly
+- float shadowDistance
+- uint shadowMask
+- Sprite2D@ sprite
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- float unitPerPixel
+- uint viewMask
+- int weakRefs // readonly
+- BoundingBox worldBoundingBox // readonly
+- float zValue
+- uint zoneMask
+
+
 ### DropDownList
 
 Methods:
@@ -3535,6 +3593,86 @@ Properties:
 - uint zoneMask
 
 
+### ParticleEmitter2D
+
+Methods:
+
+- void ApplyAttributes()
+- void DrawDebugGeometry(DebugRenderer@, bool)
+- Variant GetAttribute(const String&) const
+- Variant GetAttributeDefault(const String&) const
+- bool IsInView(Camera@) 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&)
+
+Properties:
+
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- BlendMode blendMode
+- BoundingBox boundingBox // readonly
+- bool castShadows
+- String category // readonly
+- float drawDistance
+- bool enabled
+- bool enabledEffective // readonly
+- uint id // readonly
+- bool inView // readonly
+- uint lightMask
+- float lodBias
+- Material@ material
+- uint maxLights
+- ParticleModel2D@ model
+- Node@ node // readonly
+- uint numAttributes // readonly
+- bool occludee
+- bool occluder
+- int refs // readonly
+- float shadowDistance
+- uint shadowMask
+- Sprite2D@ sprite
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- float unitPerPixel
+- uint viewMask
+- int weakRefs // readonly
+- BoundingBox worldBoundingBox // readonly
+- float zValue
+- uint zoneMask
+
+
+### ParticleModel2D
+
+Methods:
+
+- bool Load(File@)
+- bool Save(File@) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+
+Properties:
+
+- ShortStringHash baseType // readonly
+- String category // readonly
+- uint memoryUse // readonly
+- String name
+- int refs // readonly
+- ShortStringHash type // readonly
+- String typeName // readonly
+- uint useTimer // readonly
+- int weakRefs // readonly
+
+
 ### Pass
 
 Properties:
@@ -5268,6 +5406,55 @@ Properties:
 - int width
 
 
+### Sprite2D
+
+Methods:
+
+- bool Load(File@)
+- bool Save(File@) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+
+Properties:
+
+- ShortStringHash baseType // readonly
+- String category // readonly
+- Vector2 hotSpot
+- uint memoryUse // readonly
+- String name
+- IntRect rectangle
+- int refs // readonly
+- Texture2D@ texture
+- ShortStringHash type // readonly
+- String typeName // readonly
+- uint useTimer // readonly
+- int weakRefs // readonly
+
+
+### SpriteSheet2D
+
+Methods:
+
+- void DefineSprite(const String&, const IntRect&, const Vector2&)
+- Sprite2D@ GetSprite(const String&)
+- bool Load(File@)
+- bool Save(File@) const
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- void UpdateSprite(const String&, const IntRect&, const Vector2&)
+
+Properties:
+
+- ShortStringHash baseType // readonly
+- String category // readonly
+- uint memoryUse // readonly
+- String name
+- int refs // readonly
+- Texture2D@ texture // readonly
+- ShortStringHash type // readonly
+- String typeName // readonly
+- uint useTimer // readonly
+- int weakRefs // readonly
+
+
 ### StaticModel
 
 Methods:
@@ -5394,6 +5581,68 @@ Properties:
 - uint zoneMask
 
 
+### StaticSprite2D
+
+Methods:
+
+- void ApplyAttributes()
+- void DrawDebugGeometry(DebugRenderer@, bool)
+- Variant GetAttribute(const String&) const
+- Variant GetAttributeDefault(const String&) const
+- bool IsInView(Camera@) 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 SetFlip(bool, bool)
+
+Properties:
+
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- BlendMode blendMode
+- BoundingBox boundingBox // readonly
+- bool castShadows
+- String category // readonly
+- Color color
+- float drawDistance
+- bool enabled
+- bool enabledEffective // readonly
+- bool flipX
+- bool flipY
+- uint id // readonly
+- bool inView // readonly
+- uint lightMask
+- float lodBias
+- Material@ material
+- uint maxLights
+- Node@ node // readonly
+- uint numAttributes // readonly
+- bool occludee
+- bool occluder
+- int refs // readonly
+- float shadowDistance
+- uint shadowMask
+- Sprite2D@ sprite
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- float unitPerPixel
+- uint viewMask
+- int weakRefs // readonly
+- BoundingBox worldBoundingBox // readonly
+- float zValue
+- uint zoneMask
+
+
 ### String
 
 Methods:
@@ -7152,6 +7401,12 @@ Properties:
 - EMITTER_BOX
 
 
+### EmitterType2D
+
+- EMITTER_TYPE_GRAVITY
+- EMITTER_TYPE_RADIAL
+
+
 ### FileMode
 
 - FILE_READ