Vector class, which performs basic 3D vector math operations.
</brief_description>
<description>
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vecor math operations.
</description>
<methods>
<methodname="operator+">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="Vector3">
Sum.
</return>
<description>
Add two vectors.
</description>
</method>
<methodname="operator-">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="Vector3">
Difference.
</return>
<description>
Substract two vectors.
</description>
</method>
<methodname="operator/">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="Vector3">
Quotient.
</return>
<description>
Divide two vectors (component wise).
</description>
</method>
<methodname="operator*">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="Vector3">
Product.
</return>
<description>
Multiply two vectors (components wise).
</description>
</method>
<methodname="set_axis">
<argumentindex="0"name="axis"type="int">
Axis Index.
</argument>
<argumentindex="1"name="value"type="real">
Value.
</argument>
<description>
Set an individual axis (0 is X, 1 is Y and 2 is Z). the enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is specially useful for for-loops.
</description>
</method>
<methodname="get_axis">
<argumentindex="0"name="axis"type="int">
Axis Index.
</argument>
<returntype="real">
Value.
</return>
<description>
Set an individual axis (0 is X, 1 is Y and 2 is Z). the enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is specially useful for for-loops.
</description>
</method>
<methodname="length">
<returntype="real">
Length: sqrt(x^2+y^2+z^2)
</return>
<description>
Return the length of the vector.
</description>
</method>
<methodname="length_squared">
<returntype="real">
Squared Length: x^2+y^2+z^2.
</return>
<description>
Return the length of the vector, without the square root step.
</description>
</method>
<methodname="normalize">
<description>
Normalize the vector to unit length. This is the same as v = v / v.length()
</description>
</method>
<methodname="normalized">
<returntype="Vector3">
</return>
<description>
Return a copy of the normalized vector to unit length. This is the same as v / v.length()
</description>
</method>
<methodname="inverse">
<returntype="Vector3">
Inverse: 1/v
</return>
<description>
Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )
</description>
</method>
<methodname="zero">
<description>
Set x,y and z to 0.
</description>
</method>
<methodname="snap">
<argumentindex="0"name="snap"type="real">
</argument>
<description>
Snap the vector in each axis the the lowest nearest multiple. ie: 4,5,7 snapped to 2 equals 4,4,6.
</description>
</method>
<methodname="snapped">
<argumentindex="0"name="snap"type="real">
</argument>
<returntype="Vector3">
Snapped copy.
</return>
<description>
Return a copy of the vector, snapped to the lowest neared multiple.
</description>
</method>
<methodname="linear_interpolate">
<argumentindex="0"name="b"type="Vector3">
</argument>
<argumentindex="1"name="i"type="real">
</argument>
<returntype="Vector3">
</return>
<description>
Linearly interpolates the vector to a given one (b), by the given amount (i)
</description>
</method>
<methodname="cubic_interpolate">
<argumentindex="0"name="a"type="Vector3">
</argument>
<argumentindex="1"name="c"type="Vector3">
</argument>
<argumentindex="2"name="d"type="Vector3">
</argument>
<argumentindex="3"name="i"type="real">
</argument>
<returntype="Vector3">
</return>
<description>
Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i).
</description>
</method>
<methodname="cross">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="Vector3">
Cross product.
</return>
<description>
Return the cross product with b.
</description>
</method>
<methodname="dot">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="real">
</return>
<description>
Return the dot product with b.
</description>
</method>
<methodname="distance_to">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="real">
</return>
<description>
Return the distance to b.
</description>
</method>
<methodname="distance_squared_to">
<argumentindex="0"name="b"type="Vector3">
</argument>
<returntype="real">
</return>
<description>
Return the squared distance (distance minus the last square root) to b.
</description>
</method>
</methods>
<constants>
<constantname="AXIS_X"value="0">
</constant>
<constantname="AXIS_Y"value="1">
</constant>
<constantname="AXIS_Z"value="2">
</constant>
</constants>
<members>
<membername="x"type="real">
</member>
<membername="y"type="real">
</member>
<membername="z"type="real">
</member>
</members>
</class>
<classcategory="Core"name="AABB">
<brief_description>
Axis-Aligned-Bounding-Box.
</brief_description>
<description>
AABB stands for "Axis Aligned Bounding Box". It consits of a position and a size, which for an box that is always aligned to the x, y and z axis, which goes from "pos" to "pos+size".
</description>
<methods>
<methodname="has_no_area">
<returntype="bool">
</return>
<description>
Returns true if the AABB volume is empty (even if it has a surface). Holds true if size.x,y or z is 0.
</description>
</method>
<methodname="has_no_surface">
<returntype="bool">
</return>
<description>
Return true if size is 0,0,0.
</description>
</method>
<methodname="area">
<returntype="real">
</return>
<description>
Compute the volume of the AABB.
</description>
</method>
<methodname="intersects">
<argumentindex="0"name="b"type="AABB">
</argument>
<returntype="bool">
</return>
<description>
Returns true if this AABB shares a portion of space with b.
</description>
</method>
<methodname="encloses">
<argumentindex="0"name="b"type="AABB">
</argument>
<returntype="bool">
</return>
<description>
Returns true if this AABB completely encloses b.
</description>
</method>
<methodname="merge_with">
<argumentindex="0"name="b"type="AABB">
</argument>
<description>
Expand this AABB to also enclose the area of b.
</description>
</method>
<methodname="intersection_with">
<argumentindex="0"name="b"type="AABB">
</argument>
<returntype="AABB">
</return>
<description>
Return the shared portion of space with b (empty if they don't intersect).
</description>
</method>
<methodname="intersects_segment">
<argumentindex="0"name="a"type="Vector3">
</argument>
<argumentindex="1"name="b"type="Vector3">
</argument>
<argumentindex="2"name="@r"type="Vector3">
result (if they intersect)
</argument>
<argumentindex="3"name="@n"type="Vector3">
normal (if they intersect)
</argument>
<returntype="bool">
</return>
<description>
Returns true if this AABB intersects segment "a" towards "b". Also, return the point and normal of intersection.
</description>
</method>
<methodname="intersects_plane">
<argumentindex="0"name="p"type="Plane">
</argument>
<returntype="bool">
</return>
<description>
Returns true if this AABB intersects the plane b.
</description>
</method>
<methodname="has_point">
<argumentindex="0"name="p"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Return true if this AABB contains point "p".
</description>
</method>
<methodname="get_longest_axis">
<returntype="Vector3">
Axis direction
</return>
<description>
Get the normal of the longest axis in this AABB.
</description>
</method>
<methodname="get_longest_axis_index">
<returntype="int">
</return>
<description>
Get the index of the longest axis in this AABB.
</description>
</method>
<methodname="get_longest_axis_size">
<returntype="real">
Get the length of the longest axis in this AABB.
</return>
<description>
</description>
</method>
<methodname="get_edge">
<argumentindex="0"name="@ra"type="Vector3">
</argument>
<argumentindex="1"name="@rb"type="Vector3">
</argument>
<description>
Get one of the edges (0 to 11) of this AABB in "ra" and "rb".
</description>
</method>
<methodname="grow_by">
<argumentindex="0"name="s"type="real">
</argument>
<description>
Grow this AABB, by expanding its margin, by "s".
</description>
</method>
<methodname="expand_to">
<argumentindex="0"name="p"type="Vector3">
</argument>
<description>
Expand this AABB to contain point "p".
</description>
</method>
</methods>
<members>
<membername="pos"type="Vector3">
Position of the AABB.
</member>
<membername="size"type="Vector3">
Suze of the AABB (should always be positive).
</member>
</members>
</class>
<classcategory="Core"name="Plane">
<brief_description>
Plane in hessian form.
</brief_description>
<description>
Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.
</description>
<methods>
<methodname="normalize">
<description>
Normalize the plane (although it will be often normalized already).
</description>
</method>
<methodname="normalized">
<returntype="Plane">
</return>
<description>
Returns a copy of the plane, normalized.
</description>
</method>
<methodname="is_point_over">
<argumentindex="0"name="p"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Returns true if "p" is located above the plane.
</description>
</method>
<methodname="distance">
<argumentindex="0"name="p"type="Vector3">
</argument>
<returntype="real">
</return>
<description>
Returns the orthogonal distance from "p" to the plane. If positive, "p" is above, if negative, "p" is below.
</description>
</method>
<methodname="has_point">
<argumentindex="0"name="p"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Returns true if "p" is inside the plane (by a very minimum treshold).
</description>
</method>
<methodname="intersect_3">
<argumentindex="0"name="a"type="Plane">
</argument>
<argumentindex="1"name="b"type="Plane">
</argument>
<argumentindex="2"name="@r"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r".
</description>
</method>
<methodname="intersects_ray">
<argumentindex="0"name="p"type="Vector3">
</argument>
<argumentindex="1"name="d"type="Vector3">
</argument>
<argumentindex="2"name="@r"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r".
</description>
</method>
<methodname="intersects_segment">
<argumentindex="0"name="sa"type="Vector3">
</argument>
<argumentindex="1"name="sb"type="Vector3">
</argument>
<argumentindex="2"name="@r"type="Vector3">
</argument>
<returntype="bool">
</return>
<description>
Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r".
</description>
</method>
<methodname="project">
<argumentindex="0"name="p"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Returns the orthogonal projection of point "p" into a point in the plane.
</description>
</method>
<methodname="is_almost_like">
<argumentindex="0"name="b"type="plane">
</argument>
<returntype="bool">
</return>
<description>
Returns true if plane "b" is very similar to this one.
</description>
</method>
</methods>
<members>
<membername="normal"type="Vector3">
Plane normal vector (a,c and d in the plane equation normalized).
</member>
<membername="d"type="real">
Plane distance (d in the plane equation).
</member>
</members>
</class>
<classcategory="Core"name="Quat">
<brief_description>
Quaternion.
</brief_description>
<description>
Quaternion is a 4 dimensional vector that is used to represet a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues.
</description>
<methods>
<methodname="length">
<returntype="real">
</return>
<description>
Returns the length of the quaternion.
</description>
</method>
<methodname="length_squared">
<returntype="real">
</return>
<description>
Returns the length of the quaternion, minus the square root.
</description>
</method>
<methodname="normalize">
<description>
Normalize the quaternion to unit length.
</description>
</method>
<methodname="normalized">
<returntype="Quat">
</return>
<description>
Returns a copy of the quaternion, normalized to unit length.
</description>
</method>
<methodname="inverse">
<returntype="Quat">
</return>
<description>
Returns the inverse of the quaternion (applies to the inverse rotatio too).
</description>
</method>
<methodname="dot">
<argumentindex="0"name="b"type="Quat">
</argument>
<returntype="real">
</return>
<description>
Returns the dot product between two quaternions.
</description>
</method>
<methodname="set_euler">
<argumentindex="0"name="e"type="Vector3">
</argument>
<description>
Create a quaternion from euler rotation "e", as yaw, pitch, roll.
</description>
</method>
<methodname="slerp">
<argumentindex="0"name="b"type="Quat">
</argument>
<argumentindex="1"name="i"type="real">
</argument>
<returntype="Quat">
</return>
<description>
Perform a spherical-linear interpolation with another quaternion.
</description>
</method>
<methodname="operator*">
<argumentindex="0"name="arg1"type="Quat">
</argument>
<returntype="Quat">
</return>
<description>
Peform multiplication between two quaternions.
</description>
</method>
</methods>
<members>
<membername="x"type="real">
x-axis
</member>
<membername="y"type="real">
y-axis
</member>
<membername="z"type="real">
z-axis
</member>
<membername="w"type="real">
w-axis
</member>
</members>
</class>
<classcategory="Core"name="Matrix3">
<brief_description>
3x3 Matrix.
</brief_description>
<description>
Matrix represent a 3x3 (3 rows by 3 columns) transformation matrix. it is used mainly to represent and accumulate transformations such as rotation or scale when used as an OCS (oriented coordinate system).
Transpose the matrix (transformations are reversed only for orthogonal matrices).
</description>
</method>
<methodname="inverse">
<returntype="Matrix3">
</return>
<description>
Returns the inverse of the matrix.
</description>
</method>
<methodname="transposed">
<returntype="Matrix3">
</return>
<description>
Returns the transposition of the matrix.
</description>
</method>
<methodname="rotate">
<argumentindex="0"name="axis"type="Vector3">
</argument>
<argumentindex="1"name="phi"type="real">
</argument>
<description>
Rotates the matrix in normalized "axis" by amount "phi" in radians. (This is equivalent to glRotate from OpenGL).
</description>
</method>
<methodname="scale">
<argumentindex="0"name="s"type="Vector3">
</argument>
<description>
Scale each axis of the rotated matrix by 's".
</description>
</method>
<methodname="get_scale">
<returntype="Vector3">
</return>
<description>
Get the scale of the matrix.
</description>
</method>
<methodname="set_euler">
<argumentindex="0"name="e"type="Vector3">
</argument>
<description>
Create an orthogonal matrix from euler angles "e", as yaw, pitch, roll.
</description>
</method>
<methodname="get_euler">
<returntype="Vector3">
</return>
<description>
Computes and returns the euler engles for an orthogonal matrix, as yaw, pitch, roll.
</description>
</method>
<methodname="tdotx">
<argumentindex="0"name="v"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Computes and returns a dot product with transposed axis x.
</description>
</method>
<methodname="tdoty">
<argumentindex="0"name="v"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Computes and returns a dot product with transposed axis y.
</description>
</method>
<methodname="tdotz">
<argumentindex="0"name="arg1"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Computes and returns a dot product with transposed axis z.
</description>
</method>
<methodname="xform">
<argumentindex="0"name="v"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Transforms vector "v" by this matrix (as M x V) and returns the result.
</description>
</method>
<methodname="xform_inv">
<argumentindex="0"name="v"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Inverse-transforms vector "v" by this matrix (as V x M) and returns the result.
</description>
</method>
<methodname="get_axis">
<argumentindex="0"name="axis"type="int">
</argument>
<returntype="Vector3">
</return>
<description>
Get an axis of the OCS. (0 is X, 1 is Y and 2 is Z). The enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is equivalent to get_column().
</description>
</method>
<methodname="set_axis">
<argumentindex="0"name="axis"type="int">
</argument>
<argumentindex="1"name="v"type="Vector3">
</argument>
<description>
Set an axis of the OCS. (0 is X, 1 is Y and 2 is Z). The enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is equivalent to set_column()
</description>
</method>
<methodname="get_row">
<argumentindex="0"name="i"type="int">
</argument>
<returntype="Vector3">
</return>
<description>
Get a matrix row.
</description>
</method>
<methodname="set_row">
<argumentindex="0"name="i"type="int">
</argument>
<argumentindex="1"name="v"type="Vector3">
</argument>
<description>
Set a matrix row.
</description>
</method>
<methodname="get_column">
<argumentindex="0"name="axis"type="int">
</argument>
<returntype="Vector3">
</return>
<description>
Get a matrix column. This is equivalent to get_axis()
</description>
</method>
<methodname="set_column">
<argumentindex="0"name="axis"type="int">
</argument>
<argumentindex="1"name="av"type="Vector3">
</argument>
Set a matrix column. This is equivalent to set_axis
<description>
</description>
</method>
<methodname="operator*">
<argumentindex="0"name="N"type="Matrix3">
</argument>
<returntype="Matrix3">
</return>
<description>
Perform a matrix multiplication (M x N) and return the result.
</description>
</method>
<methodname="transpose_xform">
<argumentindex="0"name="arg1"type="Matrix3">
</argument>
<returntype="Matrix3">
</return>
<description>
Perform a transposed-matrix multiplication (Mt x N) and return the result.
</description>
</method>
</methods>
<members>
<membername="xx"type="real">
</member>
<membername="xy"type="real">
</member>
<membername="xz"type="real">
</member>
<membername="yx"type="real">
</member>
<membername="yy"type="real">
</member>
<membername="yz"type="real">
</member>
<membername="zx"type="real">
</member>
<membername="zy"type="real">
</member>
<membername="zz"type="real">
</member>
</members>
</class>
<classcategory="Core"name="Transform">
<brief_description>
Transformation.
</brief_description>
<description>
Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix.
</description>
<methods>
<methodname="invert">
<description>
Invert the transform.
</description>
</method>
<methodname="inverse">
<returntype="Transform">
</return>
<description>
Returns the inverse of the transform.
</description>
</method>
<methodname="rotate">
<argumentindex="0"name="axis"type="Vector3">
</argument>
<argumentindex="1"name="phi"type="real">
</argument>
<description>
Rotates the transform in normalized "axis" by amount "phi" in radians. (This is equivalent to glRotate from OpenGL).
</description>
</method>
<methodname="scale">
<argumentindex="0"name="s"type="Vector3">
</argument>
<description>
Scales the whole transform by "s" (including the origin)
</description>
</method>
<methodname="get_basis">
<returntype="Matrix3">
</return>
<description>
Get the basis.
</description>
</method>
<methodname="translate">
<argumentindex="0"name="v"type="Vector3">
</argument>
<description>
Translate the transform by "v".
</description>
</method>
<methodname="set_look_at">
<argumentindex="0"name="eye"type="Vector3">
"Eye" Position.
</argument>
<argumentindex="1"name="target"type="Vector3">
"Target" Position.
</argument>
<argumentindex="2"name="up"type="Vector3">
"Up" Normal Vector.
</argument>
<description>
Creates a transform positioned at "eye", looking towards "target". "up" represents the direction where "up" is. This function is useful for setting up cameras.
</description>
</method>
<methodname="xform">
<argumentindex="0"name="v"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Transforms vector "v" by this transform.
</description>
</method>
<methodname="xform_inv">
<argumentindex="0"name="arg1"type="Vector3">
</argument>
<returntype="Vector3">
</return>
<description>
Inverse-transforms vector "v" by this transform.
</description>
</method>
<methodname="xform_aabb">
<argumentindex="0"name="a"type="AABB">
</argument>
<returntype="AABB">
</return>
<description>
Transforms AABB "a" by this transform. The resulting aabb will often be larger, so succesive transforms are not recommended.
</description>
</method>
<methodname="xform_aabb_inv">
<argumentindex="0"name="a"type="AABB">
</argument>
<returntype="AABB">
</return>
<description>
Inverse-transforms AABB "a" by this transform. The resulting aabb will often be larger, so succesive transforms are not recommended.
</description>
</method>
<methodname="xform_plane">
<argumentindex="0"name="p"type="Plane">
</argument>
<returntype="Plane">
</return>
<description>
Transform plane "p" by this transform.
</description>
</method>
<methodname="xform_plane_inv">
<argumentindex="0"name="p"type="Plane">
</argument>
<returntype="Plane">
</return>
<description>
Inverse-transforms plane "p" by this transform.
</description>
</method>
</methods>
<members>
<membername="basis"type="Matrix3">
Transform "basis" or OCS.
</member>
<membername="origin"type="Vector3">
Transform origin.
</member>
<membername="xx"type="real">
</member>
<membername="xy"type="real">
</member>
<membername="xz"type="real">
</member>
<membername="yx"type="real">
</member>
<membername="yy"type="real">
</member>
<membername="yz"type="real">
</member>
<membername="zx"type="real">
</member>
<membername="zy"type="real">
</member>
<membername="zz"type="real">
</member>
<membername="tx"type="real">
</member>
<membername="ty"type="real">
</member>
<membername="tz"type="real">
</member>
</members>
</class>
<classcategory="Core"name="Vector2">
<brief_description>
Vector used for 2D Math.
</brief_description>
<description>
Vector class, which performs basic 2D vector math operations.
Returns the result of the linear interpolation between this vector and "b", by amount "i".
</description>
</method>
<methodname="dot">
<argumentindex="0"name="b"type="Vector2">
</argument>
<returntype="real">
</return>
<description>
Returns the dot product with vector "b".
</description>
</method>
<methodname="distance_to">
<argumentindex="0"name="b"type="Vector2">
</argument>
<returntype="real">
</return>
<description>
Returns the distance to vector "b".
</description>
</method>
<methodname="floor">
<returntype="Vector2">
</return>
<description>
Remove the fractional part of x and y.
</description>
</method>
</methods>
<members>
<membername="x"type="real">
</member>
<membername="y"type="real">
</member>
</members>
</class>
<classcategory="Core"name="Rect2">
<brief_description>
Positioned rectangle in 2D.
</brief_description>
<description>
Rect2 represets a positioned rectangle of position "pos" and "size".
</description>
<methods>
<methodname="has_no_area">
<returntype="bool">
</return>
<description>
Returns "true" if the rectangle has no area.
</description>
</method>
<methodname="has_point">
<argumentindex="0"name="v"type="Vector2">
</argument>
<returntype="bool">
</return>
<description>
Returns true if v is contained within the rectangle.
</description>
</method>
<methodname="merge">
<argumentindex="0"name="b"type="Rect2">
</argument>
<description>
Extend the rectangle to enclose "b".
</description>
</method>
<methodname="clip">
<argumentindex="0"name="b"type="Rect2">
</argument>
<returntype="Rect2">
</return>
<description>
Return the interection with rectangle "b"
</description>
</method>
<methodname="grow">
<argumentindex="0"name="m"type="Vector2">
</argument>
<description>
Extend the rectangle margin by "m".
</description>
</method>
</methods>
<members>
<membername="pos"type="Vector2">
Position of the rectangle.
</member>
<membername="size"type="Vector2">
Size of the rectangle.
</member>
<membername="x"type="real">
</member>
<membername="y"type="real">
</member>
<membername="size_x"type="real">
</member>
<membername="size_y"type="real">
</member>
</members>
</class>
<classcategory="Core"name="Color">
<brief_description>
Color in RGBA format.
</brief_description>
<description>
A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency.
</description>
<methods>
<methodname="to_32">
<returntype="real">
</return>
<description>
Convert the color to a 32 its integer (each byte represets a RGBA).
</description>
</method>
<methodname="gray">
<returntype="real">
</return>
<description>
Convert the color to gray.
</description>
</method>
<methodname="get_h">
<returntype="real">
</return>
<description>
Compute the "hue" of the color.
</description>
</method>
<methodname="get_s">
<returntype="real">
</return>
<description>
Compute the "saturation" of the color.
</description>
</method>
<methodname="get_v">
<returntype="real">
</return>
<description>
Compute the "value" of the color.
</description>
</method>
<methodname="set_hsv">
<argumentindex="0"name="h"type="real">
</argument>
<argumentindex="1"name="s"type="real">
</argument>
<argumentindex="2"name="v"type="real">
</argument>
<description>
Set the color from the HSV format.
</description>
</method>
<methodname="invert">
<description>
Invert the color.
</description>
</method>
<methodname="contrast">
<description>
Contrast the color.
</description>
</method>
<methodname="interpolate">
<argumentindex="0"name="c"type="Vector3">
</argument>
<argumentindex="1"name="i"type="real">
(0 to 1)
</argument>
<description>
Linearly blend with color "c", by amount "i".
</description>
</method>
</methods>
<members>
<membername="r"type="real">
Red.
</member>
<membername="g"type="real">
Green.
</member>
<membername="b"type="real">
Blue.
</member>
<membername="a"type="real">
Alpha.
</member>
</members>
</class>
<classcategory="Core"name="Image">
<brief_description>
Two Dimensional Image.
</brief_description>
<description>
Image represents a two-dimensional representation of an image, composed by a color per pixel.
</description>
<methods>
<methodname="get_width">
<returntype="real">
</return>
<description>
Returns the width of the image (in pixels).
</description>
</method>
<methodname="get_height">
<returntype="real">
</return>
<description>
Returns the height of the image (in pixels).
</description>
</method>
<methodname="get_pixel">
<argumentindex="0"name="x"type="int">
</argument>
<argumentindex="1"name="y"type="int">
</argument>
<returntype="Color">
</return>
<description>
Get the color of the pixel at position (x,y).
</description>
</method>
<methodname="put_pixel">
<argumentindex="0"name="x"type="int">
</argument>
<argumentindex="1"name="y"type="int">
</argument>
<argumentindex="2"name="color"type="Color">
</argument>
<description>
Sets the color of the pixel at position (x,y).
</description>
</method>
<methodname="convert">
<argumentindex="0"name="format"type="int">
</argument>
<description>
Convert the image to a new format (valid values in the FORMAT_* enumeration).
</description>
</method>
<methodname="get_format">
<returntype="int">
</return>
<description>
Get the image format (valid values in the FORMAT_* enumeration).
</description>
</method>
<methodname="resize">
<argumentindex="0"name="width"type="int">
</argument>
<argumentindex="1"name="height"type="int">
</argument>
<description>
Resize the image to a new pixel resolution given by width,height.
</description>
</method>
<methodname="crop">
<argumentindex="0"name="width"type="int">
</argument>
<argumentindex="1"name="height"type="int">
</argument>
<description>
Crop the image to a new pixel resolution given by width,height.
</description>
</method>
<methodname="flip_x">
<description>
Flip the X axis of the image.
</description>
</method>
<methodname="flip_y">
<description>
Flip the Y axis of the image.
</description>
</method>
<methodname="make_mipmap">
<argumentindex="0"name="source"type="Image">
</argument>
<description>
Create a mipmap from "source" image.
</description>
</method>
<methodname="make_normalmap">
<argumentindex="0"name="height_scale"type="real">
</argument>
<description>
Create a normalmap from "height_scale" image.
</description>
</method>
<methodname="create">
<argumentindex="0"name="width"type="int">
</argument>
<argumentindex="1"name="height"type="int">
</argument>
<argumentindex="2"name="format"type="int">
</argument>
<description>
Create a new image of size width, height and format.
</description>
</method>
<methodname="import">
<argumentindex="0"name="width"type="int">
</argument>
<argumentindex="1"name="height"type="int">
</argument>
<argumentindex="2"name="format"type="int">
</argument>
<argumentindex="3"name="data"type="RawArray">
</argument>
<description>
Import an image from raw data, given a specific format.
</description>
</method>
<methodname="empty">
<returntype="bool">
</return>
<description>
Returns true if the image is empty.
</description>
</method>
<methodname="load">
<argumentindex="0"name="path"type="String">
</argument>
<returntype="Error">
</return>
<description>
Load an image from a file in "path".
</description>
</method>
</methods>
<constants>
<constantname="FORMAT_GRAYSCALE"value="0">
</constant>
<constantname="FORMAT_INTENSITY"value="1">
</constant>
<constantname="FORMAT_GRAYSCALE_ALPHA"value="2">
</constant>
<constantname="FORMAT_RGB"value="3">
</constant>
<constantname="FORMAT_RGBA"value="4">
</constant>
<constantname="FORMAT_INDEXED"value="5">
</constant>
<constantname="FORMAT_INDEXED_ALPHA"value="6">
</constant>
</constants>
</class>
<classcategory="Core"name="RID">
<brief_description>
Resource ID.
</brief_description>
<description>
RID references a resource, typically created in a server.
</description>
<methods>
<methodname="is_valid">
<returntype="bool">
</return>
<description>
Returns true if the resource is valid.
</description>
</method>
</methods>
</class>
<classcategory="Core"name="InputEvent">
<brief_description>
A struct containing information fron an input device.
</brief_description>
<description>
A struct containing information fron an input event, such as mouse, keyboard, joystick, etc. Valid event types are:<br></br>
<list>
<li> InputEvent.NONE </li>
<li> InputEvent.KEY </li>
<li> InputEvent.MOUSE_BUTTON </li>
<li> InputEvent.MOUSE_MOTION </li>
<li> InputEvent.JOYSTICK_MOTION </li>
<li> InputEvent.JOYSTICK_BUTTON </li>
</list>
</description>
<members>
<membername="ID"type="int">
Event ID. Every event as a unique ID.
</member>
<membername="type"type="int">
Event type (check description).
</member>
<membername="device"type="int">
Device that originated the event.
</member>
<membername="mouse_x"type="int">
Mouse x position (for mouse events).
</member>
<membername="mouse_y"type="int">
Mouse y position (for mouse events).
</member>
<membername="mouse_button_mask"type="int">
State of the mouse buttons as a bitmask (for key and mouse events)
</member>
<membername="mouse_global_x"type="int">
Global mouse x position (used in GUI Controls).
</member>
<membername="mouse_global_y"type="int">
Global mouse y position (used in GUI Controls).
</member>
<membername="mouse_pressed"type="bool">
if MOUSE_BUTTON was a press, this value is true.
</member>
<membername="mouse_doubleclick"type="bool">
if MOUSE_BUTTON was a doubleclick, this value is true.
</member>
<membername="mouse_button_index"type="int">
Index of the clicked button (mouse button event).
</member>
<membername="mouse_motion_x"type="int">
Relative x motion of the mouse (mouse motion event).
</member>
<membername="mouse_motion_y"type="int">
Relative y motion of the mouse (mouse motion event).
</member>
<membername="mod_alt"type="bool">
If ALT modifier is pressed, this is true (mouse and key events).
</member>
<membername="mod_shift"type="bool">
If SHIFT modifier is pressed, this is true (mouse and key events).
</member>
<membername="mod_control"type="bool">
If CONTROL modifier is pressed, this is true (mouse and key events).
</member>
<membername="mod_meta"type="bool">
If META modifier (win/apple/etc keys) is pressed, this is true (mouse and key events).
</member>
<membername="key_pressed"type="bool">
if a KEY event originated from a keypress, this is true.
</member>
<membername="key_echo"type="bool">
if a KEY event originated from an echo key, this is true.
</member>
<membername="key_unicode"type="int">
Unicode value of a key pressed (key event).
</member>
<membername="key_scancode"type="Key">
Scancode of a key pressed (check the KEY_* enumeration) (key event).
</member>
<membername="joy_button_index"type="int">
Joystick button index (joy button event).
</member>
<membername="joy_button_pressed"type="bool">
If joystick button was pressed, this is true (joy button event).
</member>
<membername="joy_button_index"type="int">
Index of the pressed/released joystick button.
</member>
<membername="joy_axis"type="int">
Axis of a joystick (joy axis event).
</member>
<membername="joy_axis_value"type="real">
Axis value a joystick, from -1 to 1 (joy axis event).
</member>
</members>
<constants>
<constantname="NONE"value="0">
Empty input event.
</constant>
<constantname="KEY"value="1">
Key pressed/released event.
</constant>
<constantname="MOUSE_BUTTON"value="2">
Mouse button pressed/released event.
</constant>
<constantname="JOYSTICK_MOTION"value="3">
Joystick axis motion event.
</constant>
<constantname="JOYSTICK_BUTTON"value="4">
Joystick button press/release event.
</constant>
</constants>
</class>
<classcategory="Core"name="FileAccess">
<brief_description>
File Access Interface.
</brief_description>
<description>
FileAccess provides access to files in the host platform (remote access to files in webserver in the web plugin, as web plugin does not access the local filesystem).
</description>
<methods>
<methodname="open">
<argumentindex="0"name="path"type="String">
Path to a file
</argument>
<argumentindex="1"name="mode"type="int">
Open mode: FileAccess.READ, FileAccess.WRITE or FileAccess.READ_WRITE
</argument>
<returntype="Error">
Error value (check the ERR_ macro for the meaning of the values)
</return>
<description>
Open a file in a given path. Error is returned if the file can't be opened, is nt found, etc.
</description>
</method>
<methodname="close">
<description>
Closes a currently open file.
</description>
</method>
<methodname="is_open">
<returntype="bool">
</return>
<description>
Returns true if a file is currently open.
</description>
</method>
<methodname="seek">
<argumentindex="0"name="pos"type="int">
</argument>
<description>
Seek to a given position (in bytes) in the file.
</description>
</method>
<methodname="seek_end">
<argumentindex="0"name="pos"type="int">
</argument>
<description>
Seek to a given position (in bytes) in the file, from the end of the file.
</description>
</method>
<methodname="get_pos">
<returntype="int">
</return>
<description>
Get the current position in the file.
</description>
</method>
<methodname="get_len">
<returntype="int">
</return>
<description>
Get the open file size (in bytes).
</description>
</method>
<methodname="eof_reached">
<returntype="bool">
</return>
<description>
Returns true if EOF was reached (read past end of file).
</description>
</method>
<methodname="get_8">
<returntype="int">
</return>
<description>
Read a byte from the file.
</description>
</method>
<methodname="get_16">
<returntype="int">
</return>
<description>
Read a 16-bits unsigned integer from the file, in little/big endian format.
</description>
</method>
<methodname="get_32">
<returntype="int">
</return>
<description>
Read a 32-bits unsigned integer from the file, in little/big endian format.
</description>
</method>
<methodname="set_endian_swap">
<argumentindex="0"name="swap"type="bool">
</argument>
<description>
Change the endian mode for reading sizes larger than a byte (read big endian files).
</description>
</method>
<methodname="get_endian_swap">
<returntype="bool">
</return>
<description>
Return the status of the endian swap.
</description>
</method>
<methodname="store_8">
<argumentindex="0"name="byte"type="int">
</argument>
<description>
Store a byte in the file.
</description>
</method>
<methodname="store_16">
<argumentindex="0"name="word"type="int">
</argument>
<description>
Store a 16-bits integer in the file.
</description>
</method>
<methodname="store_32">
<argumentindex="0"name="dword"type="int">
</argument>
<description>
Store a 32 bits integer in the file.
</description>
</method>
<methodname="file_exists">
<argumentindex="0"name="path"type="String">
</argument>
<returntype="bool">
</return>
<description>
Returns true if a given file (in path) exist.
</description>
</method>
</methods>
<constants>
<constantname="READ"value="1">
</constant>
<constantname="WRITE"value="2">
</constant>
<constantname="READ_WRITE"value="4">
</constant>
</constants>
</class>
<classcategory="Core"name="Dir">
<brief_description>
Directory Tree Access Interface.
</brief_description>
<description>
Dir provides access to directories in the host platform (remote access to files in webserver in the web plugin, as web plugin does not access the local filesystem).
</description>
<methods>
<methodname="list_dir_begin">
<returntype="bool">
true if an error ocurred.
</return>
<description>
Begin a directory listing. This is done iteratively due to the positility of directories with a large amount of entries.
</description>
</method>
<methodname="get_next">
<returntype="String">
</return>
<description>
Get the next item. If the return value is empty (""), then the end of the directory has been reached.
</description>
</method>
<methodname="current_is_dir">
<returntype="bool">
</return>
<description>
Returns true if the current item is a directory (not a file).
</description>
</method>
<methodname="list_dir_end">
<description>
End the directory listing.
</description>
</method>
<methodname="get_drive_count">
<returntype="int">
</return>
<description>
Get the amount of drives (windows only, returns 0 on other platforms).
</description>
</method>
<methodname="get_drive">
<argumentindex="0"name="di"type="int">
</argument>
<returntype="String">
</return>
<description>
Get the string (or character) representing the drive (such as "C","D",etc).
</description>
</method>
<methodname="change_dir">
<argumentindex="0"name="dir"type="String">
</argument>
<returntype="bool">
</return>
<description>
Change the current directory of the dir access. "dir" can be either absolute or relative.
</description>
</method>
<methodname="get_current_dir">
<returntype="String">
</return>
<description>
Get the full path of the current dir.
</description>
</method>
<methodname="get_dir_separator">
<returntype="String">
</return>
<description>
Get the string or character most commonly used as drive separator in the host OS.
</description>
</method>
<methodname="make_dir">
<argumentindex="0"name="name"type="String">
</argument>
<returntype="bool">
true on error.
</return>
<description>
Create a new directory. "name" can be either absolute or relative.
</description>
</method>
<methodname="file_exists">
<argumentindex="0"name="path"type="String">
</argument>
<returntype="bool">
</return>
<description>
Returns true if a file exist. "path" can be either absolute or relative.
</description>
</method>
<methodname="get_space_left">
<returntype="int">
</return>
<description>
Return the space left on the device, in kilobytes.
</description>
</method>
</methods>
</class>
<classcategory="Core"name="VideoMode">
<brief_description>
Video Mode structure.
</brief_description>
<description>
Describes a video mode.
</description>
<members>
<membername="width"type="int">
</member>
<membername="height"type="int">
</member>
<membername="fullscreen"type="bool">
"true" if the video mode is full scren.
</member>
<membername="resizable"type="bool">
"true" if the video mode can be resized to another video mode.
</member>
</members>
</class>
<classcategory="Core"name="Date">
<brief_description>
Date structure.
</brief_description>
<description>
Describes a date.
</description>
<members>
<membername="year"type="int">
year (integer)
</member>
<membername="day"type="int">
day of the year
</member>
<membername="weekday"type="int">
day of the week (0 to 6)
</member>
<membername="month"type="int">
month of the year (0 to 11)
</member>
<membername="dst"type="bool">
"true" if daylight savings is enabled.
</member>
</members>
</class>
<classcategory="Core"name="Time">
<brief_description>
Current Time.
</brief_description>
<description>
Describes the current time.
</description>
<members>
<membername="hour"type="int">
(0 to 11)
</member>
<membername="min"type="int">
(0 to 59)
</member>
<membername="sec"type="int">
(0 to 59)
</member>
</members>
</class>
<classcategory="Core"name="OS">
<brief_description>
Operating System common functions.
</brief_description>
<description>
OS provides access to common host OS functions. "OS" Must not be instanced. All members are static (called like OS.get_name() ).
</description>
<methods>
<methodname="alert">
<argumentindex="0"name="text"type="String">
</argument>
<description>
Produce an alert. On OSs such as windows or mac, this may result in a popup dialog.
</description>
</method>
<methodname="set_mouse_show">
<argumentindex="0"name="show"type="bool">
</argument>
<description>
Determine the hardware cursor visibility (if available).
</description>
</method>
<methodname="set_mouse_grab">
<argumentindex="0"name="grab"type="bool">
</argument>
<description>
Capture the hardware cursor (if available).
</description>
</method>
<methodname="is_mouse_grab_enabled">
<returntype="bool">
</return>
<description>
Returns true if the application is capturing the hardware cursor.
</description>
</method>
<methodname="get_name">
<returntype="String">
</return>
<description>
Get the name of the host OS or Platform.
</description>
</method>
<methodname="set_video_mode">
<argumentindex="0"name="mode"type="VideoMode">
</argument>
<description>
Change the current videomode (if available).
</description>
</method>
<methodname="get_video_mode">
<returntype="VideoMode">
</return>
<description>
Get the current videomode.
</description>
</method>
<methodname="get_date">
<returntype="Date">
</return>
<description>
Get the current date.
</description>
</method>
<methodname="get_time">
<returntype="Time">
</return>
<description>
Get the current time.
</description>
</method>
<methodname="get_ticks_msec">
<returntype="int">
</return>
<description>
Get the amount of milliseconds since the app started.
</description>
</method>
<methodname="delay_usec">
<argumentindex="0"name="usec"type="int">
</argument>
<description>
Suspend the calling thread for "usec" milliseconds
</description>
</method>
</methods>
</class>
<classcategory="Core"name="Math">
<brief_description>
Common math functions.
</brief_description>
<description>
Math provides implementations of commonly used math functions."Math" shouldt not be instanced since all members are static (called like Math.cos() ).
</description>
<methods>
<methodname="sin">
<argumentindex="0"name="rad"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="cos">
<argumentindex="0"name="rad"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="tan">
<argumentindex="0"name="rad"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="asin">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="acos">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="atan2">
<argumentindex="0"name="x"type="real">
</argument>
<argumentindex="1"name="y"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="deg2rad">
<argumentindex="0"name="deg"type="real">
</argument>
<returntype="real">
</return>
<description>
Degrees to Radians conversion.
</description>
</method>
<methodname="sqrt">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="pow">
<argumentindex="0"name="base"type="real">
</argument>
<argumentindex="1"name="power"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="exp">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="log">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="fmod">
<argumentindex="0"name="x"type="real">
</argument>
<argumentindex="1"name="y"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="stepify">
<argumentindex="0"name="x"type="real">
</argument>
<argumentindex="1"name="step"type="real">
</argument>
<returntype="real">
</return>
<description>
Round to nearest (lowest) value in given step.
</description>
</method>
<methodname="floor">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="round">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="real">
</return>
<description>
</description>
</method>
<methodname="decimals">
<argumentindex="0"name="s"type="real">
</argument>
<returntype="int">
</return>
<description>
Returns the amount of decimals used by "s".
</description>
</method>
<methodname="randf">
<returntype="real">
</return>
<description>
Returns a random number fro 0 to 1
</description>
</method>
<methodname="random">
<argumentindex="0"name="min"type="real">
</argument>
<argumentindex="1"name="max"type="real">
</argument>
<returntype="real">
</return>
<description>
Returns a random number between "min" and "max"
</description>
</method>
</methods>
<constants>
<constantname="PI"value="3.14159265358979323846">
</constant>
</constants>
</class>
<classcategory="Core"name="Shell">
<brief_description>
Shell Execution interface.
</brief_description>
<description>
Shell allows the application to open a given URL in the host OS. It can be anything the host OS understands, from a web page to a media file.
</description>
<methods>
<methodname="exec">
<argumentindex="0"name="url"type="String">
</argument>
<description>
Open any URL the host OS understands.
</description>
</method>
</methods>
</class>
<classcategory="Core"name="ResourceLoader">
<brief_description>
Resource Loader.
</brief_description>
<description>
ResourceLoader loads resources from disk and returns a resource object.
</description>
<methods>
<methodname="load">
<argumentindex="0"name="path"type="String">
</argument>
<returntype="Resource">
null on failure.
</return>
<description>
Open a resource in the given path.
</description>
</method>
</methods>
</class>
<classcategory="Core"name="SceneLoader">
<brief_description>
Scene Loader
</brief_description>
<description>
SceneLoader loads scenes from disk and returns a scene node.
</description>
<methods>
<methodname="load">
<argumentindex="0"name="path"type="String">
</argument>
<returntype="Node">
A scene node, null on error.
</return>
<description>
Load a scene from disk at given "path" and return a node object.
</description>
</method>
</methods>
</class>
<classcategory="Core"name="Object">
<brief_description>
Base class for the Object Model.
</brief_description>
<description>
Object is the building block of most of the high level engine interfaces. The "Object" interface contains a reference to an actual internal Object.
Usually, Object memory should not be managed by the API, as resources will be fred automatically when not in use and nodes are deleted by their parent nodes.
</description>
<methods>
<methodname="free">
<description>
Free the Object reference. This should not be used with nodes inside a scene tree, as they are removed by their parent node. This function can also be used to unreference resources.
</description>
</method>
<methodname="get_type">
<returntype="String">
</return>
<description>
Get a string with the type name of the object.
</description>
</method>
<methodname="has_instance">
<returntype="bool">
</return>
<description>
Returns true if the Object datatype contains a reference to an actual object instance.
</description>
</method>
<methodname="get_instance_ID">
<returntype="bool">
</return>
<description>
Return the instance ID of the object. Every Object has a unique instance ID.
</description>
</method>
<methodname="is_type"qualifiers="const">
<returntype="bool">
</return>
<argumentindex="0"name="type"type="String">
</argument>
<description>
Return true if the type of the object class (or any base clases) match "type.
</description>
</method>
<methodname="set">
<argumentindex="0"name="property"type="String">
</argument>
<argumentindex="1"name="value"type="var">
</argument>
<description>
Set a property "property", with any value "value. This function can be inherited with "_set" (but base class "_set" will still be called).
</description>
</method>
<methodname="get"qualifiers="const">
<returntype="var">
</return>
<argumentindex="0"name="property"type="String">
</argument>
<description>
Return a property "property". This function can be inherited with "_get" (but base class "_get" will still be called).
Perform a notification. Notifications are quick ways to tell an Object that something happened or changed regarding it's state and surroundings. This function can be inherited with "_notification" (but base class "_notification" will still be called).
</description>
</method>
<methodname="set_script">
<argumentindex="0"name="script"type="RefPtr">
</argument>
<description>
Set the script of the object. Any object can contain a script. Scripts behave as if they inherited the object they are set to
</description>
</method>
<methodname="get_script"qualifiers="const">
<returntype="RefPtr">
</return>
<description>
Return the script of the object. Any object can contain a script. Scripts behave as if they inherited the object they are set to
</description>
</method>
<methodname="set_meta">
<argumentindex="0"name="name"type="String">
</argument>
<description>
Set a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object.
</description>
</method>
<methodname="get_meta"qualifiers="const">
<argumentindex="0"name="name"type="String">
</argument>
<description>
Return a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object.
</description>
</method>
<methodname="has_meta"qualifiers="const">
<returntype="bool">
</return>
<argumentindex="0"name="name"type="String">
</argument>
<description>
Return wether an object has a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object.
</description>
</method>
<methodname="get_meta_list"qualifiers="const">
<returntype="StringArray">
</return>
<description>
Return the list of meta properties in the object. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object.
</description>
</method>
<methodname="call">
<argumentindex="0"name="method"type="String">
</argument>
<description>
Call any method in the object (syntax: call("method", .. arguments..).
This notification is called right after the object is done initializing
</constant>
<constantname="NOTIFICATION_PREDELETE"value="1">
This notification is called right before the object will e deleted.
</constant>
</constants>
</class>
<classcategory="Core"name="Key">
<brief_description>
All Symbolic Key Names
</brief_description>
<description>
Key is an enumaration containing the constants for all the symbolic key names. They are used directly (not with Key. prefix). This value is used in the "scancode" field of the "KEY" InputEvent.
</description>
<constants>
<constantname="SPKEY">Special Key Mask</constant>
<constantname="KEY_ESCAPE"></constant>
<constantname="KEY_TAB"></constant>
<constantname="KEY_BACKTAB"></constant>
<constantname="KEY_BACKSPACE"></constant>
<constantname="KEY_RETURN"></constant>
<constantname="KEY_ENTER"></constant>
<constantname="KEY_INSERT"></constant>
<constantname="KEY_DELETE"></constant>
<constantname="KEY_PAUSE"></constant>
<constantname="KEY_PRINT"></constant>
<constantname="KEY_SYSREQ"></constant>
<constantname="KEY_CLEAR"></constant>
<constantname="KEY_HOME"></constant>
<constantname="KEY_END"></constant>
<constantname="KEY_LEFT"></constant>
<constantname="KEY_UP"></constant>
<constantname="KEY_RIGHT"></constant>
<constantname="KEY_DOWN"></constant>
<constantname="KEY_PAGEUP"></constant>
<constantname="KEY_PAGEDOWN"></constant>
<constantname="KEY_SHIFT"></constant>
<constantname="KEY_CONTROL"></constant>
<constantname="KEY_META"></constant>
<constantname="KEY_ALT"></constant>
<constantname="KEY_CAPSLOCK"></constant>
<constantname="KEY_NUMLOCK"></constant>
<constantname="KEY_SCROLLLOCK"></constant>
<constantname="KEY_F1"></constant>
<constantname="KEY_F2"></constant>
<constantname="KEY_F3"></constant>
<constantname="KEY_F4"></constant>
<constantname="KEY_F5"></constant>
<constantname="KEY_F6"></constant>
<constantname="KEY_F7"></constant>
<constantname="KEY_F8"></constant>
<constantname="KEY_F9"></constant>
<constantname="KEY_F10"></constant>
<constantname="KEY_F11"></constant>
<constantname="KEY_F12"></constant>
<constantname="KEY_F13"></constant>
<constantname="KEY_F14"></constant>
<constantname="KEY_F15"></constant>
<constantname="KEY_F16"></constant>
<constantname="KEY_KP_ENTER"></constant>
<constantname="KEY_KP_MULTIPLY"></constant>
<constantname="KEY_KP_DIVIDE"></constant>
<constantname="KEY_KP_SUBSTRACT"></constant>
<constantname="KEY_KP_PERIOD"></constant>
<constantname="KEY_KP_ADD"></constant>
<constantname="KEY_KP_0"></constant>
<constantname="KEY_KP_1"></constant>
<constantname="KEY_KP_2"></constant>
<constantname="KEY_KP_3"></constant>
<constantname="KEY_KP_4"></constant>
<constantname="KEY_KP_5"></constant>
<constantname="KEY_KP_6"></constant>
<constantname="KEY_KP_7"></constant>
<constantname="KEY_KP_8"></constant>
<constantname="KEY_KP_9"></constant>
<constantname="KEY_SUPER_L"></constant>
<constantname="KEY_SUPER_R"></constant>
<constantname="KEY_MENU"></constant>
<constantname="KEY_HYPER_L"></constant>
<constantname="KEY_HYPER_R"></constant>
<constantname="KEY_HELP"></constant>
<constantname="KEY_DIRECTION_L"></constant>
<constantname="KEY_DIRECTION_R"></constant>
<constantname="KEY_BACK"></constant>
<constantname="KEY_FORWARD"></constant>
<constantname="KEY_STOP"></constant>
<constantname="KEY_REFRESH"></constant>
<constantname="KEY_VOLUMEDOWN"></constant>
<constantname="KEY_VOLUMEMUTE"></constant>
<constantname="KEY_VOLUMEUP"></constant>
<constantname="KEY_BASSBOOST"></constant>
<constantname="KEY_BASSUP"></constant>
<constantname="KEY_BASSDOWN"></constant>
<constantname="KEY_TREBLEUP"></constant>
<constantname="KEY_TREBLEDOWN"></constant>
<constantname="KEY_MEDIAPLAY"></constant>
<constantname="KEY_MEDIASTOP"></constant>
<constantname="KEY_MEDIAPREVIOUS"></constant>
<constantname="KEY_MEDIANEXT"></constant>
<constantname="KEY_MEDIARECORD"></constant>
<constantname="KEY_HOMEPAGE"></constant>
<constantname="KEY_FAVORITES"></constant>
<constantname="KEY_SEARCH"></constant>
<constantname="KEY_STANDBY"></constant>
<constantname="KEY_OPENURL"></constant>
<constantname="KEY_LAUNCHMAIL"></constant>
<constantname="KEY_LAUNCHMEDIA"></constant>
<constantname="KEY_LAUNCH0"></constant>
<constantname="KEY_LAUNCH1"></constant>
<constantname="KEY_LAUNCH2"></constant>
<constantname="KEY_LAUNCH3"></constant>
<constantname="KEY_LAUNCH4"></constant>
<constantname="KEY_LAUNCH5"></constant>
<constantname="KEY_LAUNCH6"></constant>
<constantname="KEY_LAUNCH7"></constant>
<constantname="KEY_LAUNCH8"></constant>
<constantname="KEY_LAUNCH9"></constant>
<constantname="KEY_LAUNCHA"></constant>
<constantname="KEY_LAUNCHB"></constant>
<constantname="KEY_LAUNCHC"></constant>
<constantname="KEY_LAUNCHD"></constant>
<constantname="KEY_LAUNCHE"></constant>
<constantname="KEY_LAUNCHF"></constant>
<constantname="KEY_UNKNOWN"></constant>
<constantname="KEY_SPACE"></constant>
<constantname="KEY_EXCLAM"></constant>
<constantname="KEY_QUOTEDBL"></constant>
<constantname="KEY_NUMBERSIGN"></constant>
<constantname="KEY_DOLLAR"></constant>
<constantname="KEY_PERCENT"></constant>
<constantname="KEY_AMPERSAND"></constant>
<constantname="KEY_APOSTROPHE"></constant>
<constantname="KEY_PARENLEFT"></constant>
<constantname="KEY_PARENRIGHT"></constant>
<constantname="KEY_ASTERISK"></constant>
<constantname="KEY_PLUS"></constant>
<constantname="KEY_COMMA"></constant>
<constantname="KEY_MINUS"></constant>
<constantname="KEY_PERIOD"></constant>
<constantname="KEY_SLASH"></constant>
<constantname="KEY_0"></constant>
<constantname="KEY_1"></constant>
<constantname="KEY_2"></constant>
<constantname="KEY_3"></constant>
<constantname="KEY_4"></constant>
<constantname="KEY_5"></constant>
<constantname="KEY_6"></constant>
<constantname="KEY_7"></constant>
<constantname="KEY_8"></constant>
<constantname="KEY_9"></constant>
<constantname="KEY_COLON"></constant>
<constantname="KEY_SEMICOLON"></constant>
<constantname="KEY_LESS"></constant>
<constantname="KEY_EQUAL"></constant>
<constantname="KEY_GREATER"></constant>
<constantname="KEY_QUESTION"></constant>
<constantname="KEY_AT"></constant>
<constantname="KEY_A"></constant>
<constantname="KEY_B"></constant>
<constantname="KEY_C"></constant>
<constantname="KEY_D"></constant>
<constantname="KEY_E"></constant>
<constantname="KEY_F"></constant>
<constantname="KEY_G"></constant>
<constantname="KEY_H"></constant>
<constantname="KEY_I"></constant>
<constantname="KEY_J"></constant>
<constantname="KEY_K"></constant>
<constantname="KEY_L"></constant>
<constantname="KEY_M"></constant>
<constantname="KEY_N"></constant>
<constantname="KEY_O"></constant>
<constantname="KEY_P"></constant>
<constantname="KEY_Q"></constant>
<constantname="KEY_R"></constant>
<constantname="KEY_S"></constant>
<constantname="KEY_T"></constant>
<constantname="KEY_U"></constant>
<constantname="KEY_V"></constant>
<constantname="KEY_W"></constant>
<constantname="KEY_X"></constant>
<constantname="KEY_Y"></constant>
<constantname="KEY_Z"></constant>
<constantname="KEY_BRACKETLEFT"></constant>
<constantname="KEY_BACKSLASH"></constant>
<constantname="KEY_BRACKETRIGHT"></constant>
<constantname="KEY_ASCIICIRCUM"></constant>
<constantname="KEY_UNDERSCORE"></constant>
<constantname="KEY_QUOTELEFT"></constant>
<constantname="KEY_BRACELEFT"></constant>
<constantname="KEY_BAR"></constant>
<constantname="KEY_BRACERIGHT"></constant>
<constantname="KEY_ASCIITILDE"></constant>
<constantname="KEY_NOBREAKSPACE"></constant>
<constantname="KEY_EXCLAMDOWN"></constant>
<constantname="KEY_CENT"></constant>
<constantname="KEY_STERLING"></constant>
<constantname="KEY_CURRENCY"></constant>
<constantname="KEY_YEN"></constant>
<constantname="KEY_BROKENBAR"></constant>
<constantname="KEY_SECTION"></constant>
<constantname="KEY_DIAERESIS"></constant>
<constantname="KEY_COPYRIGHT"></constant>
<constantname="KEY_ORDFEMININE"></constant>
<constantname="KEY_GUILLEMOTLEFT"></constant>
<constantname="KEY_NOTSIGN"></constant>
<constantname="KEY_HYPHEN"></constant>
<constantname="KEY_REGISTERED"></constant>
<constantname="KEY_MACRON"></constant>
<constantname="KEY_DEGREE"></constant>
<constantname="KEY_PLUSMINUS"></constant>
<constantname="KEY_TWOSUPERIOR"></constant>
<constantname="KEY_THREESUPERIOR"></constant>
<constantname="KEY_ACUTE"></constant>
<constantname="KEY_MU"></constant>
<constantname="KEY_PARAGRAPH"></constant>
<constantname="KEY_PERIODCENTERED"></constant>
<constantname="KEY_CEDILLA"></constant>
<constantname="KEY_ONESUPERIOR"></constant>
<constantname="KEY_MASCULINE"></constant>
<constantname="KEY_GUILLEMOTRIGHT"></constant>
<constantname="KEY_ONEQUARTER"></constant>
<constantname="KEY_ONEHALF"></constant>
<constantname="KEY_THREEQUARTERS"></constant>
<constantname="KEY_QUESTIONDOWN"></constant>
<constantname="KEY_AGRAVE"></constant>
<constantname="KEY_AACUTE"></constant>
<constantname="KEY_ACIRCUMFLEX"></constant>
<constantname="KEY_ATILDE"></constant>
<constantname="KEY_ADIAERESIS"></constant>
<constantname="KEY_ARING"></constant>
<constantname="KEY_AE"></constant>
<constantname="KEY_CCEDILLA"></constant>
<constantname="KEY_EGRAVE"></constant>
<constantname="KEY_EACUTE"></constant>
<constantname="KEY_ECIRCUMFLEX"></constant>
<constantname="KEY_EDIAERESIS"></constant>
<constantname="KEY_IGRAVE"></constant>
<constantname="KEY_IACUTE"></constant>
<constantname="KEY_ICIRCUMFLEX"></constant>
<constantname="KEY_IDIAERESIS"></constant>
<constantname="KEY_ETH"></constant>
<constantname="KEY_NTILDE"></constant>
<constantname="KEY_OGRAVE"></constant>
<constantname="KEY_OACUTE"></constant>
<constantname="KEY_OCIRCUMFLEX"></constant>
<constantname="KEY_OTILDE"></constant>
<constantname="KEY_ODIAERESIS"></constant>
<constantname="KEY_MULTIPLY"></constant>
<constantname="KEY_OOBLIQUE"></constant>
<constantname="KEY_UGRAVE"></constant>
<constantname="KEY_UACUTE"></constant>
<constantname="KEY_UCIRCUMFLEX"></constant>
<constantname="KEY_UDIAERESIS"></constant>
<constantname="KEY_YACUTE"></constant>
<constantname="KEY_THORN"></constant>
<constantname="KEY_SSHARP"></constant>
<constantname="KEY_DIVISION"></constant>
<constantname="KEY_YDIAERESIS"></constant>
<constantname="KEY_CODE_MASK"></constant>
<constantname="KEY_MODIFIER_MASK"></constant>
<constantname="KEY_MASK_SHIFT"></constant>
<constantname="KEY_MASK_ALT"></constant>
<constantname="KEY_MASK_META"></constant>
<constantname="KEY_MASK_CTRL"></constant>
<constantname="KEY_MASK_KPAD"></constant>
<constantname="KEY_MASK_GROUP_SWITCH"></constant>
</constants>
</class>
<classcategory="Core"name="PropertyHint">
<brief_description>
Property Hints.
</brief_description>
<description>
PropertyHint hints editors on how to edit a property. In many cases, hint_string (in the PropertyInfo) will contain extra data. These constants are used globally ("PropertyHint" class doesn't exist").
</description>
<constants>
<constantname="PROPERTY_HINT_NONE"></constant>
<constantname="PROPERTY_HINT_RANGE">Hint_string defined as "min,max,step
"</constant>
<constantname="PROPERTY_HINT_ENUM">Values such as 0,1,2 are represented in hint_string as "A,B,C"</constant>
<constantname="PROPERTY_HINT_LENGTH">hint_string is the length of an array type.</constant>
<constantname="PROPERTY_HINT_FLAGS">Flags names are in hint_string from MSB to LSB as "flag8,fla7,flag6,,,,flag1"</constant>
<constantname="PROPERTY_HINT_PATH">Property is a path.</constant>
<constantname="PROPERTY_HINT_FILE">Property is a path to a file.</constant>
<constantname="PROPERTY_HINT_DIR">Property is a path to a dir.</constant>
<constantname="PROPERTY_HINT_RESOURCE_TYPE">hint_string contains the valid resource types the property accept (separated by ",").</constant>
</constants>
</class>
<classcategory="Core"name="PropertyUsage">
<brief_description>
Usage for an object property.
</brief_description>
<description>
PropertyUsage defines a list of (inclusive) usages that can be ORed together to specify how the property will be treated in different scenarios. These constants are used globally ("PropertyUsage" class doesn't exist").
</description>
<constants>
<constantname="PROPERTY_USAGE_STORAGE"> Property is Saved/Loaded from disk.</constant>
<constantname="PROPERTY_USAGE_EDITOR">Property is visible in editor (for editing).</constant>
<constantname="PROPERTY_USAGE_NETWORK">Property can be syncronized on network.</constant>
