Mostly Harmless
UE3:TextureFlipBook (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. |
TextureFlipBook FlipBook texture support base class.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
Properties[edit]
Property group 'FlipBook'[edit]
bAutoPlay[edit]
Type: bool
Whether the movie should automatically start playing when it is loaded.
Default value: True
bLooping[edit]
Type: bool
Whether the movie should loop when it reaches the end.
Default value: True
FBMethod[edit]
Type: TextureFlipBookMethod
FrameRate[edit]
Type: float
The time to display a single frame
Default value: 4.0
HorizontalImages[edit]
Type: int
The horizontal and vertical sub-image count
Default value: 1
VerticalImages[edit]
Type: int
Default value: 1
Internal variables[edit]
bPaused[edit]
Type: bool
Modifiers: const
Whether the movie is currently paused.
bStopped[edit]
Type: bool
Modifiers: const
Whether the movie is currently stopped.
CurrentColumn[edit]
Type: int
Modifiers: const, transient
The current sub-image column
CurrentRow[edit]
Type: int
Modifiers: const, transient
The current sub-image row
FrameTime[edit]
Type: float
Modifiers: private
Default value: 0.25
HorizontalScale[edit]
Type: float
Modifiers: const, transient
The horizontal scale factor
ReleaseResourcesFence[edit]
Type: pointer{FRenderCommandFence}
Modifiers: native, const
Command fence used to shut down properly
RenderOffsetU[edit]
Type: float
Modifiers: const, transient
The current sub-image row for the render-thread
RenderOffsetV[edit]
Type: float
Modifiers: const, transient
The current sub-image column for the render-thread
TimeIntoMovie[edit]
Type: float
Modifiers: const, transient
Time into the movie in seconds.
TimeSinceLastFrame[edit]
Type: float
Modifiers: const, transient
Time that has passed since the last frame. Will be adjusted by decoder to combat drift.
VerticalScale[edit]
Type: float
Modifiers: const, transient
The vertical scale factor
Default values[edit]
| Property | Value |
|---|---|
| AddressX | TA_Clamp |
| AddressY | TA_Clamp |
Enums[edit]
TextureFlipBookMethod[edit]
FlipBookMethod
This defines the order by which the images should be 'flipped through' TFBM_UL_ROW Start upper-left, go across to the the right, go to the next row down left-most and repeat. TFBM_UL_COL Start upper-left, go down to the bottom, pop to the top of the next column to the right and repeat. TFBM_UR_ROW Start upper-right, go across to the the left, go to the next row down right-most and repeat. TFBM_UR_COL Start upper-right, go down to the bottom, pop to the top of the next column to the left and repeat. TFBM_LL_ROW Start lower-left, go across to the the right, go to the next row up left-most and repeat. TFBM_LL_COL Start lower-left, go up to the top, pop to the bottom of the next column to the right and repeat. TFBM_LR_ROW Start lower-right, go across to the the left, go to the next row up left-most and repeat. TFBM_LR_COL Start lower-right, go up to the top, pop to the bottom of the next column to the left and repeat. TFBM_RANDOM Randomly select the next image
- TFBM_UL_ROW
- TFBM_UL_COL
- TFBM_UR_ROW
- TFBM_UR_COL
- TFBM_LL_ROW
- TFBM_LL_COL
- TFBM_LR_ROW
- TFBM_LR_COL
- TFBM_RANDOM
Native functions[edit]
Pause[edit]
Pauses the movie.
Play[edit]
Plays the movie and also unpauses.
SetCurrentFrame[edit]
Sets the current frame of the 'movie'.
Stop[edit]
Stops movie playback.
