Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel
Difference between revisions of "UE3:Actor (UT3)"
(Talk) |
m (→Latent functions) |
||
| Line 505: | Line 505: | ||
{{code|native(261) final latent function '''FinishAnim''' ({{cl|AnimNodeSequence}} '''SeqNode''')}} | {{code|native(261) final latent function '''FinishAnim''' ({{cl|AnimNodeSequence}} '''SeqNode''')}} | ||
| − | + | Returns when the animation in the specified node sequence has finished. | |
====Sleep==== | ====Sleep==== | ||
{{code|native(256) final latent function '''Sleep''' ([[float]] '''Seconds''')}} | {{code|native(256) final latent function '''Sleep''' ([[float]] '''Seconds''')}} | ||
| − | + | Returns after the specified amount of game time has passed. | |
===Native functions=== | ===Native functions=== | ||
Latest revision as of 18:46, 10 November 2010
 |
Object >> Actor |
Contents
- 1 Constants
- 2 Properties
- 3 Enums
- 4 Structs
- 5 Functions
- Package:
- Engine
- Direct subclasses:
- UTCustomChar_Preview, Camera, UTProcessedCharacterCache, Controller, UTBreakablePowerCables, DecalActor, Brush, CameraActor, DecalManager, DialogueManager, DroppedPickup, DynamicSMActor, EmitterPool, Emitter, FlockAttractor, FlockTestActor, FlockTest_Spawner, HUD, Info, InventoryManager, Inventory, KAsset, Keypoint, LensFlareSource, Light, UTWarfareChildBarricade, MaterialInstanceActor, MatineeActor, NavigationPoint, Note, Pawn, PhysAnimTestActor, PrefabInstance, Projectile, RB_ConstraintActor, RB_CylindricalForceActor, RB_LineImpulseActor, RB_RadialForceActor, RB_RadialImpulseActor, RB_Thruster, SceneCaptureActor, SkeletalMeshActor, SpeedTreeActor, StaticMeshActorBase, Trigger, UTVehicleBoostPad, UTAvoidMarker, UTCarriedObject, UTDarkWalkerBeamLight, UTDeployedActor, UTGib, UTJumpBootEffect, UTLinkBeamLight, UTOnslaughtGodBeam, UTPowerCorePanel, UTWalkerBody, UTWeaponAttachment, UTWeaponShield, VehicleMovementEffect, UTHeroBomb
- This class in other games:
- RTNP, U1, UT, UE2Runtime, UT2003, U2, UT2004, U2XMP, UDK
| 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. |
Actor: The base class of all actors. Actor is the base class of all gameplay objects. A large number of properties, behaviors and interfaces are implemented in Actor, including:
- Display - Animation - Physics and world interaction - Making sounds - Networking properties - Actor creation and destruction - Actor iterator functions - Message broadcasting
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
Constants[edit]
TRACEFLAG_Bullet[edit]
Value: 1
List of extra trace flags
TRACEFLAG_PhysicsVolumes[edit]
Value: 2
TRACEFLAG_SkipMovers[edit]
Value: 4
TRACEFLAG_Blocking[edit]
Value: 8
REP_RBLOCATION_ERROR_TOLERANCE_SQ[edit]
Value: 16.0f
when bReplicateRigidBodyLocation is true, the root body of a ragdoll will be replicated but this is not entirely accurate (and isn't meant to be) as the other bodies in the ragdoll may interfere this can then result in jittering from the client constantly trying to apply the replicated value so if the client's error is less than this amount from the replicated value, it will be ignored
MINFLOORZ[edit]
Value: 0.7
ACTORMAXSTEPHEIGHT[edit]
Value: 35.0
max height floor walking actor can step up to
RBSTATE_LINVELSCALE[edit]
Value: 10.0
RBSTATE_ANGVELSCALE[edit]
Value: 1000.0
RB_None[edit]
Value: 0x00
Not set, empty
RB_NeedsUpdate[edit]
Value: 0x01
If bNewData & RB_NeedsUpdate != 0 then an update is needed
RB_Sleeping[edit]
Value: 0x02
if bNewData & RB_Sleeping != 0 then this RigidBody needs to sleep
Properties[edit]
Property group 'Advanced'[edit]
bConsiderAllStaticMeshComponentsForStreaming[edit]
Type: bool
If true, texture streaming code iterates over all StaticMeshComponents found on this actor when building texture streaming information.
bEdShouldSnap[edit]
Type: bool
Snap to grid in editor.
bHiddenEd[edit]
Type: bool
Modifiers: const
Is hidden during editing.
bHiddenEdGroup[edit]
Type: bool
Modifiers: const
Is hidden by the group brower.
bLockLocation[edit]
Type: bool
Prevent the actor from being moved in the editor.
Property group 'Attachment'[edit]
Base[edit]
Type: Actor
Modifiers: const
Actor we're standing on.
BaseBoneName[edit]
Type: name
BaseSkelComponent[edit]
Type: SkeletalMeshComponent
bHardAttach[edit]
Type: bool
Modifiers: const
bIgnoreBaseRotation[edit]
Type: bool
bShadowParented[edit]
Type: bool
If TRUE, BaseSkelComponent is used as the shadow parent for this actor.
Property group 'Collision'[edit]
bCollideComplex[edit]
Type: bool
Ignore Simple Collision on Static Meshes, and collide per Poly.
BlockRigidBody[edit]
Type: bool
Modifiers: const, transient
mirrored copy of CollisionComponent's BlockRigidBody for the Actor property window for LDs (so it's next to CollisionType) purely for editing convenience and not used at all by the physics code
bNoEncroachCheck[edit]
Type: bool
For encroachers, don't do the overlap check when they move. You will not get touch events for this actor moving, but it is much faster. This is an optimisation for large numbers of PHYS_RigidBody actors for example.
bPathColliding[edit]
Type: bool
this actor should collide (if bWorldGeometry && bBlockActors is true) during path building (ignored if bStatic is true, as actor will always collide during path building)
bPhysRigidBodyOutOfWorldCheck[edit]
Type: bool
If true, do a zero-extent trace each frame from old to new Location when in PHYS_RigidBody. If it hits the world (ie might be tunneling), call FellOutOfWorld.
CollisionComponent[edit]
Type: PrimitiveComponent
CollisionType[edit]
Type: ECollisionType
Modifiers: const, transient
enum for LDs to select collision options - sets Actor flags and that of our CollisionComponent via PostEditChange()
Default value: COLLIDE_NoCollision
Property group 'Debug'[edit]
bDebug[edit]
Type: bool
Property group 'Display'[edit]
bHidden[edit]
Type: bool
Modifiers: const
If this is True, all PrimitiveComponents of the actor are hidden. If this is false, only PrimitiveComponents with HiddenGame=True are hidden.
DrawScale[edit]
Type: float
Modifiers: const, interp
Scaling factor, 1.0=normal size.
Default value: 1.0
DrawScale3D[edit]
Type: Object.Vector
Modifiers: const, interp
Scaling vector, (1.0,1.0,1.0)=normal size.
Default value:
| Member | Value |
|---|---|
| X | 1.0 |
| Y | 1.0 |
| Z | 1.0 |
PrePivot[edit]
Type: Object.Vector
Modifiers: const
Property group 'Movement'[edit]
DesiredRotation[edit]
Type: Object.Rotator
Physics will smoothly rotate actor to this rotation.
Location[edit]
Type: Object.Vector
Modifiers: const
Actor's location; use Move to set.
Physics[edit]
Type: EPhysics
Modifiers: const
Rotation[edit]
Type: Object.Rotator
Modifiers: const
Rotation.
RotationRate[edit]
Type: Object.Rotator
Change in rotation per second.
[edit]
[edit]
Type: bool
indicates that this Actor can dynamically block AI paths
Property group 'Object'[edit]
Group[edit]
Type: name
Tag[edit]
Type: name
Actor's tag name.
Property group 'Physics'[edit]
MinDistForNetRBCorrection[edit]
Type: float
If linear error is less than this, will not be corrected by net update.
Internal variables[edit]
Enums[edit]
ECollisionType[edit]
enum for LDs to select collision options - sets Actor flags and that of our CollisionComponent via PostEditChange()
- COLLIDE_CustomDefault
- custom programmer set collison (PostEditChange() will restore collision to defaults when this is selected)
- COLLIDE_NoCollision
- doesn't collide
- COLLIDE_BlockAll
- blocks everything
- COLLIDE_BlockWeapons
- only blocks zero extent things (usually weapons)
- COLLIDE_TouchAll
- touches (doesn't block) everything
- COLLIDE_TouchWeapons
- touches (doesn't block) only zero extent things
- COLLIDE_BlockAllButWeapons
- only blocks non-zero extent things (Pawns, etc)
- COLLIDE_TouchAllButWeapons
- touches (doesn't block) only non-zero extent things
EDoubleClickDir[edit]
- DCLICK_None
- DCLICK_Left
- DCLICK_Right
- DCLICK_Forward
- DCLICK_Back
- DCLICK_Active
- DCLICK_Done
EMoveDir[edit]
The set of Directions an actor can be moving *
- MD_Stationary
- MD_Forward
- MD_Backward
- MD_Left
- MD_Right
- MD_Up
- MD_Down
ENetRole[edit]
- ROLE_None
- No role at all.
- ROLE_SimulatedProxy
- Locally simulated proxy of this actor.
- ROLE_AutonomousProxy
- Locally autonomous proxy of this actor.
- ROLE_Authority
- Authoritative control over the actor.
EPhysics[edit]
- PHYS_None
- PHYS_Walking
- PHYS_Falling
- PHYS_Swimming
- PHYS_Flying
- PHYS_Rotating
- PHYS_Projectile
- PHYS_Interpolating
- PHYS_Spider
- PHYS_Ladder
- PHYS_RigidBody
- PHYS_SoftBody
- PHYS_Unused
- update bounding boxes and killzone test, otherwise like PHYS_None
ETravelType[edit]
- TRAVEL_Absolute
- Absolute URL.
- TRAVEL_Partial
- Partial (carry name, reset server).
- TRAVEL_Relative
- Relative URL.
Structs[edit]
See Actor structs.
Functions[edit]
Static native functions[edit]
DrawDebugBox[edit]
Draw a debug box
DrawDebugCone[edit]
Draw a debug cone
DrawDebugCoordinateSystem[edit]
Draw Debug coordinate system
DrawDebugCylinder[edit]
Draw a debug cylinder
DrawDebugLine[edit]
Draw a debug line
DrawDebugSphere[edit]
Draw a debug sphere
FlushPersistentDebugLines[edit]
Flush persistent lines
GetPackageGuid[edit]
Looks up the GUID of a package on disk. The package must NOT be in the autodownload cache. This may require loading the header of the package in question and is therefore slow.
Other static functions[edit]
GetLocalString[edit]
ReplaceText[edit]
Iterator functions[edit]
AllActors[edit]
AllOwnedComponents[edit]
Iterates over all components directly or indirectly attached to this actor.
Parameters:
- BaseClass - Only components deriving from BaseClass will be iterated upon.
- OutComponent - The iteration variable.
BasedActors[edit]
ChildActors[edit]
CollidingActors[edit]
ComponentList[edit]
Returns each component in the Components list author: superville
DynamicActors[edit]
LocalPlayerControllers[edit]
iterator LocalPlayerControllers() returns all locally rendered/controlled player controllers (typically 1 per client, unless split screen)
OverlappingActors[edit]
Returns colliding (bCollideActors==true) which overlap a Sphere from location 'Loc' and 'Radius' radius.
Parameters:
- BaseClass - The Actor returns must be a subclass of this.
- out_Actor - returned Actor at each iteration.
- Radius - Radius of sphere for overlapping check.
- Loc - Center of sphere for overlapping check. (Optional, caller's location is used otherwise).
- bIgnoreHidden - if true, ignore bHidden actors.
TouchingActors[edit]
TraceActors[edit]
VisibleActors[edit]
VisibleCollidingActors[edit]
Latent functions[edit]
FinishAnim[edit]
Returns when the animation in the specified node sequence has finished.
Sleep[edit]
Returns after the specified amount of game time has passed.
Native functions[edit]
Events[edit]
See Actor events.
