Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.FileWriter

Extends
Info
Modifiers
native

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved. This is a simple class that allows for secure writing of output files from within Script. The directory to which it writes files is determined by the file type member variable.

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.FileWriter

Direct Known Subclasses:

FileLog

Constants Summary
Inherited Contants from Engine.Actor
ACTORMAXSTEPHEIGHT, MINFLOORZ, RBSTATE_ANGVELSCALE, RBSTATE_LINVELSCALE, RB_NeedsUpdate, RB_None, RB_Sleeping, REP_RBLOCATION_ERROR_TOLERANCE_SQ, TRACEFLAG_Blocking, TRACEFLAG_Bullet, TRACEFLAG_PhysicsVolumes, TRACEFLAG_SkipMovers

Variables Summary
pointerArchivePtr
boolbFlushEachWrite
boolbWantsAsyncWrites
stringFilename
FWFileTypeFileType
Inherited Variables from Engine.Actor
Acceleration, AllComponents, AngularVelocity, Attached, bAllowFluidSurfaceInteraction, bAlwaysEncroachCheck, bAlwaysRelevant, bAlwaysTick, Base, BaseBoneName, BaseSkelComponent, bBlockActors, bBlocksNavigation, bBlocksTeleport, bBounce, bCallRigidBodyWakeEvents, bCanBeAdheredTo, bCanBeDamaged, bCanBeFrictionedTo, bCanStepUpOn, bCanTeleport, bCollideActors, bCollideAsEncroacher, bCollideComplex, bCollideWhenPlacing, bCollideWorld, bComponentOutsideWorld, bConsiderAllStaticMeshComponentsForStreaming, bDebug, bDebugEffectIsRelevant, bDeleteMe, bDemoOwner, bDemoRecording, bDestroyedByInterpActor, bDestroyInPainVolume, bEditable, bEdShouldSnap, bExchangedRoles, bForceAllowKismetModification, bForceDemoRelevant, bForceNetUpdate, bForceOctreeSNFilter, bGameRelevant, bHardAttach, bHasAlternateTargetLocation, bHidden, bHiddenEd, bHiddenEdCustom, bHiddenEdGroup, bHiddenEdLevel, bHiddenEdTemporary, bHurtEntry, bIgnoreBaseRotation, bIgnoreEncroachers, bIgnoreRigidBodyPawns, bIsMoving, bJustTeleported, bKillDuringLevelTransition, bLockLocation, BlockRigidBody, bMovable, bMoveIgnoresDestruction, bNetDirty, bNetInitial, bNetInitialRotation, bNetOwner, bNetTemporary, bNoDelete, bNoEncroachCheck, bOnlyDirtyReplication, bOnlyOwnerSee, bOnlyRelevantToOwner, bOrientOnSlope, bPathColliding, bPathTemp, bPendingDelete, bPendingNetUpdate, bPhysRigidBodyOutOfWorldCheck, bPostRenderIfNotVisible, bProjTarget, bPushedByEncroachers, bReplicateInstigator, bReplicateMovement, bReplicateRigidBodyLocation, bRigidBodyWasAwake, bRouteBeginPlayEvenIfStatic, bScriptInitialized, bShadowParented, bShouldBaseAtStartup, bSkipActorPropertyReplication, bStatic, bTearOff, bTempEditor, bTicked, bTickIsDisabled, bUpdateSimulatedPosition, bWorldGeometry, Children, CollisionComponent, CollisionType, Components, CreationTime, CustomTimeDilation, DetachFence, DrawScale3D, DrawScale, EditorIconColor, GeneratedEvents, Group, HiddenEditorViews, InitialState, Instigator, LastNetUpdateTime, LastRenderTime, LatentActions, LatentFloat, LatentSeqNode, LifeSpan, Location, MessageClass, NetPriority, NetTag, NetUpdateFrequency, NetUpdateTime, OverlapTag, Owner, PendingTouch, Physics, PhysicsVolume, PrePivot, RelativeLocation, RelativeRotation, RemoteRole, ReplicatedCollisionType, Role, Rotation, RotationRate, SupportedEvents, Tag, TickFrequency, TickFrequencyAtEndDistance, TickFrequencyDecreaseDistanceEnd, TickFrequencyDecreaseDistanceStart, TickFrequencyLastSeenTimeBeforeForcingMaxTickFrequency, TickGroup, Timers, TimeSinceLastTick, Touching, Velocity, WorldInfo

Enumerations Summary
FWFileType
FWFT_Log, FWFT_Stats, FWFT_HTML, FWFT_User, FWFT_Debug,
Inherited Enumerations from Engine.Actor
ECollisionType, EDoubleClickDir, EMoveDir, ENetRole, EPhysics, ETravelType

Structures Summary
Inherited Structures from Engine.Info
KeyValuePair, PlayerResponseLine, ServerResponseLine
Inherited Structures from Engine.Actor
ActorReference, AnimSlotDesc, AnimSlotInfo, BasedPosition, CollisionImpactData, ImpactInfo, NavReference, PhysEffectInfo, RigidBodyContactInfo, RigidBodyState, TimerData, TraceHitInfo

Functions Summary
function CloseFile ()
event Destroyed ()))
function Logf (coerce string logString)
functionbool OpenFile (coerce string InFilename, optional FWFileType InFileType, optional string InExtension, optional bool bUnique, optional bool bIncludeTimeStamp)
Inherited Functions from Engine.Actor
ActivateEventClass, AllActors, AllOwnedComponents, AnimTreeUpdated, ApplyFluidSurfaceImpact, Attach, AttachComponent, AutonomousPhysics, BaseChange, BasedActors, BecomeViewTarget, BeginAnimControl, bool, BP2Vect, BroadcastLocalizedMessage, BroadcastLocalizedTeamMessage, Bump, CalcCamera, CalculateMinSpeedTrajectory, CanActorPlayFaceFXAnim, CanSplash, ChartData, CheckForErrors, CheckHitInfo, ChildActors, ClampRotation, ClearAllTimers, ClearLatentAction, ClearTimer, Clock, CollidingActors, CollisionChanged, ComponentList, ConsoleCommand, ConstraintBrokenNotify, ContainsPoint, CreateAudioComponent, CreateForceField, DebugFreezeGame, DebugMessagePlayer, Destroyed, Detach, DetachComponent, DisplayDebug, DoKismetAttachment, DrawDebugBox, DrawDebugCone, DrawDebugCoordinateSystem, DrawDebugCylinder, DrawDebugFrustrum, DrawDebugLine, DrawDebugPoint, DrawDebugSphere, DrawDebugStar, DrawDebugString, DynamicActors, EffectIsRelevant, EncroachedBy, EncroachingOn, EndViewTarget, Falling, FastTrace, FellOutOfWorld, FindBase, FindEventsOfClass, FindGoodEndView, FindSpot, FinishAnim, FinishAnimControl, fixedTurn, FlushDebugStrings, FlushPersistentDebugLines, ForceNetRelevant, ForceUpdateComponents, GainedChild, GetActorEyesViewPoint, GetActorFaceFXAsset, GetAggregateBaseVelocity, GetAimAdhesionExtent, GetAimFrictionExtent, GetALocalPlayerController, GetAvoidanceVector, GetBasedPosition, GetBaseMost, GetBoundingCylinder, GetComponentsBoundingBox, GetDebugName, GetDestination, GetFaceFXAudioComponent, GetGravityZ, GetHumanReadableName, GetItemName, GetLocalString, GetPackageGuid, GetPhysicsName, GetRemainingTimeForTimer, GetTargetLocation, GetTeamNum, GetTerminalVelocity, GetTimerCount, GetTimerRate, GetURLMap, HealDamage, HitWall, HurtRadius, InterpolationChanged, InterpolationFinished, InterpolationStarted, IsActorPlayingFaceFXAnim, IsBasedOn, IsBlockedBy, IsInPain, IsInPersistentLevel, IsOverlapping, IsOwnedBy, IsPlayerOwned, IsStationary, IsTimerActive, KilledBy, Landed, LocalPlayerControllers, LostChild, MakeNoise, MatchStarting, ModifyHearSoundComponent, ModifyTimerTimeDilation, Move, MoveSmooth, MovingWhichWay, NativePostRenderFor, NotifyLocalPlayerTeamReceived, NotifySkelControlBeyondLimit, OnAnimEnd, OnAnimPlay, OnAttachToActor, OnChangeCollision, OnDestroy, OnModifyHealth, OnRanOver, OnRigidBodySpringOverextension, OnSetBlockRigidBody, OnSetPhysics, OnSetVelocity, OnSleepRBPhysics, OnTeleport, OnToggleHidden, OnWakeRBPhysics, OutsideWorldBounds, OverlappingActors, OverRotated, PauseTimer, PawnBaseDied, PhysicsVolumeChange, PlayActorFaceFXAnim, PlayerCanSeeMe, PlayParticleEffect, PlaySound, PlayTeleportEffect, PointCheckComponent, PostBeginPlay, PostDemoRewind, PostInitAnimTree, PostRenderFor, PostTeleport, PostTouch, PreBeginPlay, PrestreamTextures, PreTeleport, RanInto, ReattachComponent, ReceivedNewEvent, ReplaceText, ReplicatedEvent, ReplicationEnded, Reset, ResetTimerTimeDilation, RigidBodyCollision, RootMotionExtracted, RootMotionModeChanged, RootMotionProcessed, ScriptGetTeamNum, SetAnimPosition, SetBase, SetBasedPosition, SetCollision, SetCollisionSize, SetCollisionType, SetDrawScale, SetDrawScale3D, SetForcedInitialReplicatedProperty, SetHardAttach, SetHidden, SetHUDLocation, SetInitialState, SetMorphWeight, SetNetUpdateTime, SetOnlyOwnerSee, SetOwner, SetPhysics, SetRelativeLocation, SetRelativeRotation, SetRotation, SetSkelControlScale, SetTickGroup, SetTickIsDisabled, SetTimer, SetZone, ShouldBeHiddenBySHOW_NavigationNodes, ShutDown, Sleep, Spawn, SpawnedByKismet, SpecialHandling, StopActorFaceFXAnim, StopsProjectile, SuggestTossVelocity, SupportsKismetModification, TakeDamage, TakeRadiusDamage, Tick, Timer, TornOff, Touch, TouchingActors, Trace, TraceActors, TraceAllPhysicsAssetInteractions, TraceComponent, TrailsNotify, TrailsNotifyEnd, TrailsNotifyTick, TriggerEventClass, TriggerGlobalEventClass, UnClock, UnTouch, UsedBy, Vect2BP, VisibleActors, VisibleCollidingActors, VolumeBasedDestroy, WillOverlap


Variables Detail

ArchivePtr Source code

var const native pointer ArchivePtr;
Internal FArchive pointer

bFlushEachWrite Source code

var bool bFlushEachWrite;
Whether we should flush to disk every time something is written. if false, only flush when the memory buffer is full or when the file is closed

bWantsAsyncWrites Source code

var bool bWantsAsyncWrites;
Whether to use async writes (if available) or not. Overrides bFlushEachWrite

Filename Source code

var const string Filename;
File name, created via OpenFile()

FileType Source code

var const FWFileType FileType;
Holds the file type for this file.


Enumerations Detail

FWFileType Source code

enum FWFileType
{
FWFT_Log, FWFT_Stats, FWFT_HTML, FWFT_User, FWFT_Debug,
};
Type of file


Functions Detail

CloseFile Source code

native final function CloseFile ( )
Closes the log file.

Destroyed Source code

event Destroyed ( ) )
Overridden to automatically close the logfile on destruction.

Logf Source code

native final function Logf ( coerce string logString )
Logs the given string to the log file.
@param logString - string to dump

OpenFile Source code

native final function bool OpenFile ( coerce string InFilename, optional FWFileType InFileType, optional string InExtension, optional bool bUnique, optional bool bIncludeTimeStamp )
Opens the actual file using the specified name.
@param InFilename name of file to open
@param InFileType the type of file being written
@param InExtension optional file extension to use, defaults to .txt if none is specified
@param bUnique whether to make unique or not
@param bIncludeTimeStamp whether to include timestamps or not


Defaultproperties

defaultproperties
{
	bFlushEachWrite=true
	bTickIsDisabled=true
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:48.774 - Created with UnCodeX