Differences

This shows you the differences between two versions of the page.

Link to this comparison view

gdevelop5:all-features:functions [2019/01/10 12:20] (current)
bwpanda created
Line 1: Line 1:
 +====== Function reference ======
 +
 +^ Function ​      ^ Description ​             ^ Notes                                                                                                                                                                                                                                 ^
 +| **abs(A)** ​    | Absolute value. ​    | If A is negative, returns -A otherwise returns A.                                                                                                                                                                                     |
 +| **acos(A)** ​   | Arc-cosine. ​        | Returns the angle, measured in radians, whose cosine is A.                                                                                                                                                                            |
 +| **acosh(A)** ​  | Hyperbolic cosine. ​ | Same as acos() but for hyperbolic cosine. ​                                                                                                                                                                                            |
 +| **asin(A)** ​   | Arc-sine. ​          | Returns the angle, measured in radians, whose sine is A.                                                                                                                                                                              |
 +| **asinh(A)** ​  | Hyperbolic sine.    | Same as asin() but for hyperbolic sine.                                                                                                                                                                                               |
 +| **atan(A)** ​   | Arc-tangent. ​       | Returns the angle, measured in radians, whose tangent is (A).                                                                                                                                                                         |
 +| **atan2(A,​B)** | Arc-tangent of A/B. | The two main differences with atan() are that a) it will return the right angle depending on the signs of A and B (atan() can only return values betwen -pi/2 and pi/2), and that b) the return value of pi/2 and -pi/2 are possible. |
 +| **atanh(A)** ​  | Hyperbolic tangent. | Same as atan(), but for hyperbolic tangent. ​                                                                                                                                                                                          |
 +| **ceil(A)** ​   | Ceiling. ​           | Returns the smallest integer greater than A. Rounds up to the next higher integer. ​                                                                                                                                                   |
 +| **cos(A)** ​    | Cosine in radiants. | Returns the cosine of the angle A, where A is measured in radians. ​                                                                                                                                                                   |
 +| **cosh(A)** ​   | Hyperbolic cosine. ​ | Same as cos(), but for hyperbolic cosine. ​                                                                                                                                                                                            |
 +| **cot(A)** ​    | Cotangent. ​         | Cotangent of A (equivalent to 1/​tan(A)). ​                                                                                                                                                                                             |
 +| **csc(A)** ​    | Cosecant. ​          | Cosecant of A (equivalent to 1/​sin(A)). ​                                                                                                                                                                                              |
 +| **exp(A)** ​    | Exponential. ​       | Returns the value of e raised to the power A where e is the base of the natural logarithm, i.e. the non-repeating value approximately equal to 2.71828182846. ​                                                                        |
 +| **floor(A)** ​  | Floor. ​             | Returns the largest integer less than A. Rounds down to the next lower integer. ​                                                                                                                                                      |
 +| **int(A)** ​    | Round to integer. ​  | Rounds A to the closest integer. 0.5 is rounded to 1.                                                                                                                                                                                 |
 +| **log(A)** ​    | Natural logarithm. ​ | Natural (base e) logarithm of A.                                                                                                                                                                                                      |
 +| **log10(A)** ​  | Base 10 logarithm. ​ | Base 10 logarithm of A.                                                                                                                                                                                                               |
 +| **max(A,​B)** ​  | Maximum. ​           | If A>B, the result is A, else B.                                                                                                                                                                                                      |
 +| **min(A,​B)** ​  | Minimum. ​           | If A<B, the result is A, else B.                                                                                                                                                                                                      |
 +| **mod(x,​y)** ​  | Modulo. ​            | Return the result of x mod y.                                                                                                                                                                                                         |
 +| **pow(A,​B)** ​  | Exponentiation ​     | A raised to the power B.                                                                                                                                                                                                              |
 +| **sec(A)** ​    | Secant. ​            | Secant of A (equivalent to 1/​cos(A)). ​                                                                                                                                                                                                |
 +| **sin(A)** ​    | Sine.               | Returns the sine of the angle A, where A is measured in radians. ​                                                                                                                                                                     |
 +| **sinh(A)** ​   | Hyperbolic sine.    | Same as sin() but for hyperbolic sine.                                                                                                                                                                                                |
 +| **sqrt(A)** ​   | Square root.        | Returns the value whose square is A.                                                                                                                                                                                                  |
 +| **tan(A)** ​    | Tangent. ​           | Returns the tangent of the angle A, where A is measured in radians. ​                                                                                                                                                                  |
 +| **tanh(A)** ​   | Hyperbolic tangent. | Same as tan() but for hyperbolic tangent. ​                                                                                                                                                                                            |
 +
 +-----
 +
 +====== Other available functions ======
 +'​*'​ - Native platform only
 +===== Extensions =====
 +
 +==== Text Object ====
 + Text.String()
 + NewLine()
 + SubStr("​text",​charPos,​length)
 + StrAt("​text",​charPos)
 + Text.Angle()
 + Text.Opacity()
 + StrFind("​text","​whatToSearch"​)
 + StrFindFrom("​text","​whatToSearch",​posNum)
 + StrLength("​text"​)
 + StrRFind("​text","​toSearchFromEnd"​)
 + StrRFindFrom("​text","​toSearchFromEnd",​lastPosNum)
 +
 +==== Top-down movement ====
 + Object.TopDownMovement::​Acceleration()
 + Object.TopDownMovement::​AngleOffset()
 + Object.TopDownMovement::​AngularMaxSpeed()
 + Object.TopDownMovement::​Deceleration()
 + Object.TopDownMovement::​MaxSpeed()
 + Object.TopDownMovement::​Speed()
 +
 +==== Pathfinding behavior ====
 + Object.Pathfinding::​Acceleration()
 + Object.Pathfinding::​AngleOffset()
 + Object.Pathfinding::​AngularMaxSpeed()
 + Object.Pathfinding::​DestinationX()
 + Object.Pathfinding::​DestinationY()
 + Object.Pathfinding::​ExtraBorder()
 + Object.Pathfinding::​GetNodeX(nodeIndexFrom0)
 + Object.Pathfinding::​GetNodeY(nodeIndexFrom0)
 + Object.Pathfinding::​LastNodeX()
 + Object.Pathfinding::​LastNodeY()
 + Object.Pathfinding::​MaxSpeed()
 + Object.Pathfinding::​NextNodeIndex()
 + Object.Pathfinding::​NextNodeX()
 + Object.Pathfinding::​NextNodeY()
 + Object.Pathfinding::​NodeCount()
 + Object.Pathfinding::​Speed()
 + Object.Pathfinding::​CellHeight()
 + Object.Pathfinding::​CellWidth()
 +
 +==== Pathfinding Obstacle Automatism ====
 + Object.PathfindingObstacle::​Cost()
 +
 +==== Platformer character ====
 + Object.PlatformerObject::​Acceleration()
 + Object.PlatformerObject::​Deceleration()
 + Object.PlatformerObject::​Gravity()
 + Object.PlatformerObject::​JumpSpeed()
 + Object.PlatformerObject::​MaxFallingSpeed()
 + Object.PlatformerObject::​MaxSpeed()
 +
 +==== Physics behavior ====
 + Object.Physics::​AngularDamping()
 + Object.Physics::​AngularVelocity()
 + Object.Physics::​LinearDamping()
 + Object.Physics::​LinearVelocity()
 + Object.Physics::​LinearVelocityX()
 + Object.Physics::​LinearVelocityY()
 +
 +===== Native only =====
 +==== Object 3D Box * ====
 + Object.Depth()
 + Object.Pitch()
 + Object.Roll()
 + Object.Yaw()
 + Object.Z()
 +
 +==== * Object Light ====
 + Object.Intensity()
 + Object.Quality()
 + Object.Radius()
 +
 +==== * Automatism Automatic Network update ====
 + Object.NetworkUpdater::​GetIdentifier()
 +
 +==== * Object Particles emitter ====
 + Object.EmitterAngle()
 + Object.EmitterForceMax()
 + Object.EmitterForceMin()
 + Object.Flow()
 + Object.Friction()
 + Object.ParticleGravityAngle()
 + Object.ParticleGravityLength()
 + Object.Tank() - capacity
 + Object.ZoneRadius()
 + Object.EmitterAngleA()
 + Object.EmitterAngleB()
 + Object.EmitterXDirection()
 + Object.EmitterYDirection()
 + Object.EmitterZDirection()
 + Object.ParticleAlpha1()
 + Object.ParticleAlpha2()
 + Object.ParticleAngle1()
 + Object.ParticleAngle2()
 + Object.ParticleBlue1()
 + Object.ParticleBlue2()
 + Object.ParticleGravityX()
 + Object.ParticleGravityY()
 + Object.ParticleGravityZ()
 + Object.ParticleGreen1()
 + Object.ParticleGreen2()
 + Object.ParticleLifeTimeMax()
 + Object.ParticleLifeTimeMin()
 + Object.ParticleRed1()
 + Object.ParticleRed2()
 + Object.ParticleSize1()
 + Object.ParticleSize2()
 + Object.RendererParam1()
 + Object.RendererParam2()
 + Object.NbParticles() - number
 +
 +==== * Automatism Path ====
 + Object.Path::​AngleOffset()
 + Object.Path::​PathX()
 + Object.Path::​PathY()
 + Object.Path::​Position()
 + Object.Path::​Segment()
 + Object.Path::​Speed()
 +
 +==== * Object Sound ====
 + Object.Attenuation()
 + Object.MinDistance()
 + Object.Pitch()
 + Object.Volume()
 + Object.ZPos()
 +
 +==== * Text Entry ====
 + TextEntryObject.String()
 +
 +==== * Advanced XML ====
 + AdvancedXML::​GetAttributeNumber("​ElementReference","​AttrName"​)
 + AdvancedXML::​GetElementType("​ElementReference"​)
 +
 +==== * Network ====
 + Network::​GetReceivedDataValue("​DataName"​)
 +
 +==== * Sound Object: Listener ====
 + SoundObject::​ListenerDirectionX()
 + SoundObject::​ListenerDirectionY()
 + SoundObject::​ListenerDirectionZ()
 + SoundObject::​ListenerX()
 + SoundObject::​ListenerY()
 + SoundObject::​ListenerZ()
 +