Difference between revisions of "UE3:Actor native functions (UDK)"

Revision as of 05:24, 17 January 2010 (edit) (Talk) ← Older edit	Revision as of 05:36, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 1)) Newer edit →
(No difference)

---

Revision as of 05:36, 17 January 2010

Actor native functions in other games:

RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3

Other member categories for this class:

enums, events, instance functions, internal variables, 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.

Native functions

AttachComponent

Adds a component to the actor's components array, attaching it to the actor.

Parameters:

• NewComponent - The component to attach.

AutonomousPhysics

ChartData

Draw some value over time onto the StatChart. Toggle on and off with

ClampRotation

Clamps out_Rot between the upper and lower limits offset from the base

ClearAllTimers

Clears all previously set timers

ClearTimer

Clears a previously set timer, identical to calling SetTimer() with a <= 0.f rate.

Parameters:

• inTimerFunc - the name of the timer to remove or the default one if not specified

Clock

ConsoleCommand

ContainsPoint

CreateAudioComponent

Destroy

DetachComponent

Removes a component from the actor's components array, detaching it from the actor.

Parameters:

• ExComponent - The component to detach.

FastTrace

FindBase

Attempts to find a valid base for this actor

FindSpot

fixedTurn

Returns a new rotation component value

Parameters:

• Current - is the current rotation value
• Desired - is the desired rotation value
• DeltaRate - is the rotation amount to apply

ForceUpdateComponents

GetALocalPlayerController

Return first found LocalPlayerController. Fine for single player, in split screen, one will be picked.

GetAvoidanceVector

Calculates a direction (unit vector) to avoid all actors contained in Obstacles list, assuming each entry in Obstacles is also avoiding this actor. Based loosely on RVO as described in http://gamma.cs.unc.edu/RVO/icra2008.pdf .

GetBaseMost

Walks up the Base chain from this Actor and returns the Actor at the top (the eventual Base). this->Base is NULL, returns this.

GetBoundingCylinder

GetComponentsBoundingBox

GetDestination

returns the position the AI should move toward to reach this actor accounts for AI using path lanes, cutting corners, and other special adjustments

GetGravityZ

Get gravity currently affecting this actor

GetTargetLocation

Parameters:

• RequestedBy - the Actor requesting the target location
• bRequestAlternateLoc - optional) - return a secondary target location if there are multiple

Returns:

the optimal location to fire weapons at this actor

GetTeamNum

GetTerminalVelocity

returns terminal velocity (max speed while falling) for this actor. Unless overridden, it returns the TerminalVelocity of the PhysicsVolume in which this actor is located.

GetTimerCount

Gets the current count for the specified timer, defaults to 'Timer' if no function is specified. Returns -1.f if the timer is not currently active.

Parameters:

• inTimerFunc - the name of the timer to remove or the default one if not specified

GetTimerRate

Gets the current rate for the specified timer.

Parameters:

• TimerFuncName - the name of the function to check for a timer for; 'Timer' is the default

Returns:

the rate for the given timer, or -1.f if that timer is not active

Note: GetTimerRate('SomeTimer') - GetTimerCount('SomeTimer') is the time remaining before 'SomeTimer' is called

GetURLMap

IsBasedOn

iterates up the Base chain to see whether or not this Actor is based on the given Actor

Parameters:

• TestActor - the Actor to test for

Returns:

whether or not this Actor is based on TestActor

IsInPersistentLevel

whether this Actor is in the persistent level, i.e. not a sublevel

IsOverlapping

IsOwnedBy

iterates up the Owner chain to see whether or not this Actor is owned by the given Actor

Parameters:

• TestActor - the Actor to test for

Returns:

whether or not this Actor is owned by TestActor

IsPlayerOwned

Searches the owner chain looking for a player.

IsTimerActive

Returns true if the specified timer is active, defaults to 'Timer' if no function is specified.

Parameters:

• inTimerFunc - the name of the timer to remove or the default one if not specified

MakeNoise

ModifyTimerTimeDilation

This will search the Timers on this actor and set the passed in TimerTimeDilation *

Move

MoveSmooth

MovingWhichWay

This will return the direction in LocalSpace that that actor is moving. This is useful for firing off effects based on which way the actor is moving. *

NativePostRenderFor

Hook to allow actors to render HUD overlays for themselves. Assumes that appropriate font has already been set

PauseTimer

Pauses/Unpauses a previously set timer

Parameters:

• bPause - whether to pause/unpause the timer
• inTimerFunc - the name of the timer to pause or the default one if not specified
• inObj - object timer is attached to

PlayerCanSeeMe

PlaySound

PointCheckComponent

Run a point check against just this PrimitiveComponent. Return TRUE if we hit.

NOTE: the actual Actor we call this on is irrelevant!

PrestreamTextures

Calls PrestreamTextures() for all the actor's meshcomponents.

Parameters:

• Seconds - Number of seconds to force all mip-levels to be resident
• bEnableStreaming - Whether to start (TRUE) or stop (FALSE) streaming

ReattachComponent

Detaches and immediately reattaches specified component. Handles bWillReattach properly.

ResetTimerTimeDilation

This will search the Timers on this actor and reset the TimerTimeDilation to 1.0f *

SetBase

SetCollision

SetCollisionSize

SetCollisionType

SetDrawScale

SetDrawScale3D

SetForcedInitialReplicatedProperty

adds/removes a property from a list of properties that will always be replicated when this Actor is bNetInitial, even if the code thinks the client has the same value the server already does This is a workaround to the problem where an LD places an Actor in the level, changes a replicated variable away from the defaults, then at runtime the variable is changed back to the default but it doesn't replicate because initial replication is based on class defaults Only has an effect when called on bStatic or bNoDelete Actors Only properties already in the owning class's replication block may be specified

Parameters:

• PropToReplicate - the property to add or remove to the list
• bAdd - true to add the property, false to remove the property

SetHardAttach

SetHidden

Changes the value of bHidden.

Parameters:

• bNewHidden - The value to assign to bHidden.

SetHUDLocation

function used to update where icon for this actor should be rendered on the HUD

Parameters:

• NewHUDLocation - is a vector whose X and Y components are the X and Y components of this actor's icon's 2D position on the HUD

SetLocation

SetNetUpdateTime

Updates NetUpdateTime to the new value for future net relevancy checks

SetOnlyOwnerSee

changes the value of bOnlyOwnerSee

Parameters:

• bNewOnlyOwnerSee - the new value to assign to bOnlyOwnerSee

SetOwner

SetPhysics

SetRelativeLocation

SetRelativeRotation

SetRotation

SetTickGroup

Changes the ticking group for this actor

SetTickIsDisabled

turns on or off this Actor's desire to be ticked (bTickIsDisabled) because this is implemented as a separate tickable list, calls to this function to disable ticking will not take effect until the end of the current list to avoid shuffling elements around while they are being iterated over

SetTimer

Sets a timer to call the given function at a set interval. Defaults to calling the 'Timer' event if no function is specified. If InRate is set to 0.f it will effectively disable the previous timer.

NOTE: Functions with parameters are not supported!

Parameters:

• InRate - the amount of time to pass between firing
• inbLoop - whether to keep firing or only fire once
• inTimerFunc - the name of the function to call when the timer fires

SetZone

updates the zone/PhysicsVolume of this Actor

Parameters:

• bForceRefresh - forces the code to do a full collision check instead of exiting early if the current info is valid

Spawn

Spawn an actor. Returns an actor of the specified class, not of class Actor (this is hardcoded in the compiler). Returns None if the actor could not be spawned (if that happens, there will be a log warning indicating why) Defaults to spawning at the spawner's location.

Note: ActorTemplate is sent for replicated actors and therefore its properties will also be applied at initial creation on the client. However, because of this, ActorTemplate must be a static resource (an actor archetype, default object, or a bStatic/bNoDelete actor in a level package) or the spawned Actor cannot be replicated

SuggestTossVelocity

SupportsKismetModification

whether this Actor can be modified by Kismet actions primarily used by error checking to warn LDs when their Kismet may not apply changes correctly (especially on clients)

Parameters:

• AskingOp - Kismet operation to which this Actor is linked
• Reason - out) - If this function returns false, contains the reason why the Kismet action is not allowed to execute on this Actor

Returns:

whether the AskingOp can correctly modify this Actor

Trace

Trace a line and see what it collides with first. Takes this actor's collision properties into account. Returns first hit actor, Level if hit level, or None if hit nothing.

TraceAllPhysicsAssetInteractions

TraceComponent

Run a line check against just this PrimitiveComponent. Return TRUE if we hit.

NOTE: the actual Actor we call this on is irrelevant!

UnClock

WillOverlap

Steps from each position given the respective velocities performing simple radius checks