The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
UE3:Object static native functions (UDK)
 |
Object (static native functions) |
Contents
- 1 Static native functions
- 1.1 Abs
- 1.2 Acos
- 1.3 Asc
- 1.4 Asin
- 1.5 Atan
- 1.6 Atan2
- 1.7 Caps
- 1.8 Chr
- 1.9 Clamp
- 1.10 ClampLength
- 1.11 ClassIsChildOf
- 1.12 Cos
- 1.13 DebugBreak
- 1.14 DynamicLoadObject
- 1.15 Exp
- 1.16 FCeil
- 1.17 FClamp
- 1.18 FCubicInterp
- 1.19 FFloor
- 1.20 FindObject
- 1.21 FInterpConstantTo
- 1.22 FInterpEaseInOut
- 1.23 FInterpTo
- 1.24 FMax
- 1.25 FMin
- 1.26 FRand
- 1.27 GetAngularDistance
- 1.28 GetAngularFromDotDist
- 1.29 GetAxes
- 1.30 GetDotDistance
- 1.31 GetEnum
- 1.32 GetFuncName
- 1.33 GetMappedRangeValue
- 1.34 GetPerObjectConfigSections
- 1.35 GetUnAxes
- 1.36 InStr
- 1.37 InverseTransformNormal
- 1.38 InverseTransformVector
- 1.39 IsUTracing
- 1.40 IsZero
- 1.41 Left
- 1.42 Len
- 1.43 Lerp
- 1.44 Localize
- 1.45 Locs
- 1.46 Loge
- 1.47 LogInternal
- 1.48 MakeRotationMatrix
- 1.49 MakeRotationTranslationMatrix
- 1.50 MatrixGetAxis
- 1.51 MatrixGetOrigin
- 1.52 MatrixGetRotator
- 1.53 Max
- 1.54 Mid
- 1.55 Min
- 1.56 MirrorVectorByNormal
- 1.57 Normal
- 1.58 Normalize
- 1.59 NormalizeRotAxis
- 1.60 OrthoRotation
- 1.61 ParseStringIntoArray
- 1.62 PathName
- 1.63 PointProjectToPlane
- 1.64 ProjectOnTo
- 1.65 QuatDot
- 1.66 QuatFindBetween
- 1.67 QuatFromAxisAndAngle
- 1.68 QuatFromRotator
- 1.69 QuatInvert
- 1.70 QuatProduct
- 1.71 QuatRotateVector
- 1.72 QuatSlerp
- 1.73 QuatToRotator
- 1.74 Rand
- 1.75 RDiff
- 1.76 Repl
- 1.77 Right
- 1.78 RInterpTo
- 1.79 RLerp
- 1.80 RotRand
- 1.81 Round
- 1.82 RSmerp
- 1.83 RTransform
- 1.84 ScriptTrace
- 1.85 SetUTracing
- 1.86 Sin
- 1.87 Sqrt
- 1.88 Square
- 1.89 StaticSaveConfig
- 1.90 Tan
- 1.91 ToHex
- 1.92 TransformNormal
- 1.93 TransformVector
- 1.94 VInterpTo
- 1.95 VLerp
- 1.96 VRand
- 1.97 VRandCone
- 1.98 VRandCone2
- 1.99 VSize
- 1.100 VSize2D
- 1.101 VSizeSq
- 1.102 VSizeSq2D
- 1.103 VSmerp
- 1.104 WarnInternal
- Object static native functions in other games:
- RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3
- Other member categories for this class:
- functions, operators, structs
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Static native functions[edit]
Abs[edit]
Acos[edit]
Asc[edit]
Asin[edit]
Atan[edit]
Atan2[edit]
Caps[edit]
Chr[edit]
Clamp[edit]
ClampLength[edit]
Clamps a vector to not be longer than MaxLength.
ClassIsChildOf[edit]
Determine if a class is a child of another class.
Returns:
- TRUE if TestClass == ParentClass, or if TestClass is a child of ParentClass; FALSE otherwise, or if either the value for either parameter is 'None'.
Cos[edit]
DebugBreak[edit]
Script-induced breakpoint. Useful for examining state with the debugger at a particular point in script.
Parameters:
- UserFlags - user-defined flags to be used for e.g. indentifying different calls to DebugBreak in the same session
- DebuggerType - C++ debugger, UScript debugger, or both
DynamicLoadObject[edit]
Exp[edit]
FCeil[edit]
FClamp[edit]
FCubicInterp[edit]
Cubic Spline interpolation.
Parameters:
- P - end points
- T - tangent directions at end points
- Alpha - distance along spline
Returns:
- evaluated value.
FFloor[edit]
FindObject[edit]
FInterpConstantTo[edit]
Same as above, but using a constant step
FInterpEaseInOut[edit]
Interpolates with both ease-in and ease-out (smoothly departs A, smoothly approaches B).
Parameters:
- A - Value to interpolate from.
- B - Value to interpolate to.
- Alpha - Interpolant.
- Exp - Exponent. Higher values result in more rapid acceleration adn deceleration.
Returns:
- Interpolated value.
FInterpTo[edit]
Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a position. (Doesn't work well when target teleports)
Parameters:
- Current - Actual position
- Target - Target position
- DeltaTime - time since last tick
- InterpSpeed - Interpolation speed
Returns:
- new interpolated position
FMax[edit]
FMin[edit]
FRand[edit]
GetAngularDistance[edit]
Calculates the angular distance of vector 'Direction' to coordinate system O(AxisX,AxisY,AxisZ).
Orientation: (consider 'O' the first person view of the player, and 'Direction' a vector pointing to an enemy) - positive azimuth means enemy is on the right of crosshair. (negative means left). - positive elevation means enemy is on top of crosshair, negative means below.
Parameters:
- out_AngularDist - X = Azimuth angle (in radians) of 'Direction' vector compared to plane (AxisX,AxisZ). .Y = Elevation angle (in radians) of 'Direction' vector compared to plane (AxisX,AxisY).
- Direction - Direction of target.
- AxisX - X component of reference system.
- AxisY - Y component of reference system.
- AxisZ - Z component of reference system.
Output: true if 'Direction' is facing AxisX (Direction dot AxisX >= 0.f)
GetAngularFromDotDist[edit]
Converts Dot distance to angular distance.
Parameters:
- OutAngDist - Angular distance in radians.
- DotDist - Dot distance.
See: GetAngularDistance() and GetDotDistance().
GetAxes[edit]
GetDotDistance[edit]
Calculates the dotted distance of vector 'Direction' to coordinate system O(AxisX,AxisY,AxisZ).
Orientation: (consider 'O' the first person view of the player, and 'Direction' a vector pointing to an enemy) - positive azimuth means enemy is on the right of crosshair. (negative means left). - positive elevation means enemy is on top of crosshair, negative means below.
Parameters:
- OutDotDist - X = 'Direction' dot AxisX relative to plane (AxisX,AxisZ). (== Cos(Azimuth)) .Y = 'Direction' dot AxisX relative to plane (AxisX,AxisY). (== Sin(Elevation))
- Direction - direction of target.
- AxisX - X component of reference system.
- AxisY - Y component of reference system.
- AxisZ - Z component of reference system.
Returns:
- true if 'Direction' is facing AxisX (Direction dot AxisX >= 0.f)
Note: Azimuth' (.X) sign is changed to represent left/right and not front/behind. front/behind is the funtion's return value.
GetEnum[edit]
GetFuncName[edit]
Returns the current calling function's name, useful for debugging.
GetMappedRangeValue[edit]
Useful for mapping a value in one value range to a different value range. Output is clamped to the OutputRange. e.g. given that velocities [50..100] correspond to a sound volume of [0.2..1.4], find the
volume for a velocity of 77.
GetPerObjectConfigSections[edit]
Retrieve the names of sections which contain data for the specified PerObjectConfig class.
Parameters:
- SearchClass - the PerObjectConfig class to retrieve sections for.
- out_SectionNames - will receive the list of section names that correspond to PerObjectConfig sections of the specified class
- ObjectOuter - the Outer to use for determining which file to look in. Specify the same object that is used when creating the PerObjectConfig objects that sections are being retrieved for. (PerObjectConfig data is generally stored in a file named after the Outer used when creating those objects, unless the PerObjectConfig class specifies a config file in its class declaration); specify None to use the transient package as the Outer.
- MaxResults - the maximum number of section names to retrieve
Returns:
- TRUE if the file specified was found and it contained at least 1 section for the specified class
GetUnAxes[edit]
InStr[edit]
InverseTransformNormal[edit]
InverseTransformVector[edit]
IsUTracing[edit]
Returns whether script function call trace logging is currently enabled.
IsZero[edit]
Left[edit]
Len[edit]
Lerp[edit]
Localize[edit]
Locs[edit]
Loge[edit]
LogInternal[edit]
Writes a message to the log. This function should never be called directly - use the `log macro instead, which has the following signature:
log( coerce string Msg, optional bool bCondition=true, optional name LogTag='ScriptLog' );
Parameters:
- Msg - the string to print to the log
- bCondition - if specified, the message is only printed to the log if this condition is satisfied.
- LogTag - if specified, the message will be prepended with this tag in the log file
MakeRotationMatrix[edit]
MakeRotationTranslationMatrix[edit]
MatrixGetAxis[edit]
MatrixGetOrigin[edit]
MatrixGetRotator[edit]
Max[edit]
Mid[edit]
Min[edit]
MirrorVectorByNormal[edit]
Normal[edit]
Normalize[edit]
NormalizeRotAxis[edit]
Returns a Rotator axis within the [-32768,+32767] range in float
Parameters:
- RotAxis - axis of the rotator
Returns:
- Normalized axis value, within the [-32768,+32767] range.
OrthoRotation[edit]
ParseStringIntoArray[edit]
Breaks up a delimited string into elements of a string array.
Parameters:
- BaseString - The string to break up
- Pieces - The array to fill with the string pieces
- Delim - The string to delimit on
- bCullEmpty - If true, empty strings are not added to the array
PathName[edit]
Returns the full path name of the specified object (including package and groups), ie CheckObject::GetPathName().
PointProjectToPlane[edit]
Calculates a point's projection onto a plane
Parameters:
- Point - point to project onto the plane
- A - point on plane
- B - point on plane
- C - point on plane
Returns:
- projection of point onto the plane defined by ABC
ProjectOnTo[edit]
QuatDot[edit]
QuatFindBetween[edit]
QuatFromAxisAndAngle[edit]
QuatFromRotator[edit]
QuatInvert[edit]
QuatProduct[edit]
QuatRotateVector[edit]
QuatSlerp[edit]
QuatToRotator[edit]
Rand[edit]
Rand will give you a value between 0 and Max -1 *
RDiff[edit]
Gives the rotation difference between two Rotators, taking the shortest route between them (in degrees).
Repl[edit]
Right[edit]
RInterpTo[edit]
Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a position. (Doesn't work well when target teleports)
Parameters:
- Current - Actual position
- Target - Target position
- DeltaTime - time since last tick
- InterpSpeed - Interpolation speed, if !bConstantInterpSpeed will perform a continuous lerp, otherwise will interp at constant speed
Returns:
- new interpolated position
RLerp[edit]
RotRand[edit]
Round[edit]
RSmerp[edit]
RTransform[edit]
Given rotation R in the space defined by RBasis, return R in "world" space
ScriptTrace[edit]
Dumps the current script function stack to the log file, useful for debugging.
SetUTracing[edit]
Enables/disables script function call trace logging.
Sin[edit]
Sqrt[edit]
Square[edit]
StaticSaveConfig[edit]
Tan[edit]
ToHex[edit]
TransformNormal[edit]
TransformVector[edit]
VInterpTo[edit]
Tries to reach Target based on distance from Current position, giving a nice smooth feeling when tracking a location. (Doesn't work well when target teleports)
Parameters:
- Current - Actual location
- Target - Target location
- DeltaTime - time since last tick
- InterpSpeed - Interpolation speed
Returns:
- new interpolated position
VLerp[edit]
VRand[edit]
VRandCone[edit]
VRandCone2[edit]
VSize[edit]
VSize2D[edit]
VSizeSq[edit]
VSizeSq2D[edit]
VSmerp[edit]
WarnInternal[edit]
Same as calling LogInternal(SomeMsg, 'Warning'); This function should never be called directly - use the `warn macro instead, which has the following signature:
warn( coerce string Msg, optional bool bCondition=true );
