I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:TextureFlipBook (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Surface >> Texture >> Texture2D >> TextureFlipBook
Package: 
Engine
This class in other games:
UDK

TextureFlipBook FlipBook texture support base class.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'FlipBook'

bAutoPlay

Type: bool

Whether the movie should automatically start playing when it is loaded.

Default value: True

bLooping

Type: bool

Whether the movie should loop when it reaches the end.

Default value: True

FBMethod

Type: TextureFlipBookMethod


FrameRate

Type: float

The time to display a single frame

Default value: 4.0

HorizontalImages

Type: int

The horizontal and vertical sub-image count

Default value: 1

VerticalImages

Type: int


Default value: 1

Internal variables

bPaused

Type: bool

Modifiers: const

Whether the movie is currently paused.

bStopped

Type: bool

Modifiers: const

Whether the movie is currently stopped.

CurrentColumn

Type: int

Modifiers: const, transient

The current sub-image column

CurrentRow

Type: int

Modifiers: const, transient

The current sub-image row

FrameTime

Type: float

Modifiers: private


Default value: 0.25

HorizontalScale

Type: float

Modifiers: const, transient

The horizontal scale factor

ReleaseResourcesFence

Type: pointer{FRenderCommandFence}

Modifiers: native, const

Command fence used to shut down properly

RenderOffsetU

Type: float

Modifiers: const, transient

The current sub-image row for the render-thread

RenderOffsetV

Type: float

Modifiers: const, transient

The current sub-image column for the render-thread

TimeIntoMovie

Type: float

Modifiers: const, transient

Time into the movie in seconds.

TimeSinceLastFrame

Type: float

Modifiers: const, transient

Time that has passed since the last frame. Will be adjusted by decoder to combat drift.

VerticalScale

Type: float

Modifiers: const, transient

The vertical scale factor

Default values

Property Value
AddressX TA_Clamp
AddressY TA_Clamp

Enums

TextureFlipBookMethod

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

Pause

native function Pause ()

Pauses the movie.

Play

native function Play ()

Plays the movie and also unpauses.

SetCurrentFrame

native function SetCurrentFrame (int Row, int Col)

Sets the current frame of the 'movie'.

Stop

native function Stop ()

Stops movie playback.