UE3:Object static native functions (UDK)
|
Object (static native functions) |
- Object static native functions in other games:
- Other member categories for this class:
| 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
Abs
Acos
Asc
Asin
Atan
Atan2
Caps
Chr
Clamp
ClampLength
Clamps a vector to not be longer than MaxLength.
ClassIsChildOf
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
DebugBreak
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
Exp
FCeil
FClamp
FCubicInterp
Cubic Spline interpolation.
Parameters:
- P - end points
- T - tangent directions at end points
- Alpha - distance along spline
Returns:
- evaluated value.
FFloor
FindObject
FInterpConstantTo
Same as above, but using a constant step
FInterpEaseInOut
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
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
FMin
FRand
GetAngularDistance
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
Converts Dot distance to angular distance.
Parameters:
- OutAngDist - Angular distance in radians.
- DotDist - Dot distance.
See: GetAngularDistance() and GetDotDistance().
GetAxes
GetDotDistance
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
GetFuncName
Returns the current calling function's name, useful for debugging.
GetMappedRangeValue
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
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
InStr
InverseTransformNormal
InverseTransformVector
IsUTracing
Returns whether script function call trace logging is currently enabled.
IsZero
Left
Len
Lerp
Localize
Locs
Loge
LogInternal
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
MakeRotationTranslationMatrix
MatrixGetAxis
MatrixGetOrigin
MatrixGetRotator
Max
Mid
Min
MirrorVectorByNormal
Normal
Normalize
NormalizeRotAxis
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
ParseStringIntoArray
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
Returns the full path name of the specified object (including package and groups), ie CheckObject::GetPathName().
PointProjectToPlane
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
QuatDot
QuatFindBetween
QuatFromAxisAndAngle
QuatFromRotator
QuatInvert
QuatProduct
QuatRotateVector
QuatSlerp
QuatToRotator
Rand
Rand will give you a value between 0 and Max -1 *
RDiff
Gives the rotation difference between two Rotators, taking the shortest route between them (in degrees).
Repl
Right
RInterpTo
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
RotRand
Round
RSmerp
RTransform
Given rotation R in the space defined by RBasis, return R in "world" space
ScriptTrace
Dumps the current script function stack to the log file, useful for debugging.
SetUTracing
Enables/disables script function call trace logging.
Sin
Sqrt
Square
StaticSaveConfig
Tan
ToHex
TransformNormal
TransformVector
VInterpTo
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
VRand
VRandCone
VRandCone2
VSize
VSize2D
VSizeSq
VSizeSq2D
VSmerp
WarnInternal
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 );
