Browse Source

Merge branch 'master' of https://github.com/urho3d/Urho3D

aster2013 11 years ago
parent
commit
cea855fde6
3 changed files with 251 additions and 0 deletions
  1. 116 0
      Docs/AngelScriptAPI.h
  2. 40 0
      Docs/LuaScriptAPI.dox
  3. 95 0
      Docs/ScriptAPI.dox

+ 116 - 0
Docs/AngelScriptAPI.h

@@ -109,6 +109,84 @@ Zone zone;
 uint zoneMask;
 };
 
+class AnimatedSprite2D
+{
+// 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:
+Animation2D animation;
+/* 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;
+CycleMode cycleMode;
+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;
+float speed;
+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 Animation
 {
 // Methods:
@@ -148,6 +226,37 @@ uint useTimer;
 int weakRefs;
 };
 
+class Animation2D
+{
+// 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 */
+uint numKeyFrames;
+/* readonly */
+int refs;
+/* readonly */
+float totalTime;
+/* readonly */
+ShortStringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+uint useTimer;
+/* readonly */
+int weakRefs;
+};
+
 class AnimationController
 {
 // Methods:
@@ -8798,6 +8907,13 @@ CS_REJECTDROP,
 CS_BUSY,
 };
 
+enum CycleMode
+{
+CM_LOOP,
+CM_CLAMP,
+CM_PINGPONG,
+};
+
 enum DumpMode
 {
 DOXYGEN,

+ 40 - 0
Docs/LuaScriptAPI.dox

@@ -48,6 +48,23 @@ Properties:
 - unsigned numMorphs (readonly)
 - bool master (readonly)
 
+### AnimatedSprite2D : StaticSprite2D
+
+Methods:
+
+- void SetSpeed(float speed)
+- void SetCycleMode(CycleMode cycleMode)
+- void SetAnimation(Animation2D* animation)
+- float GetSpeed() const
+- CycleMode GetCycleMode() const
+- Animation2D* GetAnimation() const
+
+Properties:
+
+- float speed
+- CycleMode cycleMode
+- Animation2D* animation
+
 ### Animation : Resource
 
 Methods:
@@ -69,6 +86,20 @@ Properties:
 - unsigned numTracks (readonly)
 - unsigned numTriggers (readonly)
 
+### Animation2D : Resource
+
+Methods:
+
+- float GetTotalTime() const
+- unsigned GetNumKeyFrames() const
+- const KeyFrame2D* GetKeyFrameByTime(float time) const
+- const KeyFrame2D* GetKeyFrameByIndex(unsigned index) const
+
+Properties:
+
+- float totalTime (readonly)
+- unsigned numKeyFrames (readonly)
+
 ### AnimationControl
 
 
@@ -1672,6 +1703,9 @@ Properties:
 - unsigned numAxes (readonly)
 - unsigned numHats (readonly)
 
+### KeyFrame2D
+
+
 ### Light : Drawable
 
 Methods:
@@ -5261,6 +5295,12 @@ Properties:
 - int CS_BUSY
 - int CS_MAX_SHAPES
 
+### CycleMode
+
+- int CM_LOOP
+- int CM_CLAMP
+- int CM_PINGPONG
+
 ### DeferredLightPSVariation
 
 - int DLPS_NONE

+ 95 - 0
Docs/ScriptAPI.dox

@@ -84,6 +84,71 @@ Properties:
 - uint zoneMask
 
 
+### AnimatedSprite2D
+
+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:
+
+- Animation2D@ animation
+- Variant[] attributeDefaults // readonly
+- AttributeInfo[] attributeInfos // readonly
+- Variant[] attributes
+- ShortStringHash baseType // readonly
+- BlendMode blendMode
+- BoundingBox boundingBox // readonly
+- bool castShadows
+- String category // readonly
+- Color color
+- CycleMode cycleMode
+- 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
+- float speed
+- Sprite2D@ sprite
+- bool temporary
+- ShortStringHash type // readonly
+- String typeName // readonly
+- float unitPerPixel
+- uint viewMask
+- int weakRefs // readonly
+- BoundingBox worldBoundingBox // readonly
+- float zValue
+- uint zoneMask
+
+
 ### Animation
 
 Methods:
@@ -113,6 +178,29 @@ Properties:
 - int weakRefs // readonly
 
 
+### Animation2D
+
+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
+- uint numKeyFrames // readonly
+- int refs // readonly
+- float totalTime // readonly
+- ShortStringHash type // readonly
+- String typeName // readonly
+- uint useTimer // readonly
+- int weakRefs // readonly
+
+
 ### AnimationController
 
 Methods:
@@ -7389,6 +7477,13 @@ Properties:
 - CS_BUSY
 
 
+### CycleMode
+
+- CM_LOOP
+- CM_CLAMP
+- CM_PINGPONG
+
+
 ### DumpMode
 
 - DOXYGEN