Sci::PlaneShowStyle Struct Reference

#include <transitions32.h>

Public Attributes
reg_t	plane
ShowStyleType	type
bool	fadeUp
int16	divisions
int16	color
int	delay
bool	animate
uint32	nextTick
int	currentStep
bool	processed
Common::Array< ScreenItem * >	screenItems
uint8	numEdges
int16	width
int16	height
ScreenItem *	bitmapScreenItem
reg_t	bitmap
uint32	dissolveMask
uint32	firstPixel
uint32	pixel
Common::Array< uint16 >	fadeColorRanges

Detailed Description

A show style represents a transition applied to a Plane. One show style per plane can be active at a time.

Member Data Documentation

plane

reg_t Sci::PlaneShowStyle::plane

The ID of the plane this transition applies to.

type

ShowStyleType Sci::PlaneShowStyle::type

The type of the transition.

fadeUp

bool Sci::PlaneShowStyle::fadeUp

When true, the show style is an entry transition to a new room. When false, it is an exit transition away from an old room.

divisions

int16 Sci::PlaneShowStyle::divisions

The number of steps for the show style.

color

int16 Sci::PlaneShowStyle::color

The color used by transitions that draw CelObjColor screen items. -1 for transitions that do not draw screen items.

delay

int Sci::PlaneShowStyle::delay

The amount of time, in ticks, between each cycle of the animation.

animate

bool Sci::PlaneShowStyle::animate

If true, GfxTransitions32 will yield back to the main game loop after calculating the next frame. Otherwise, GfxTransitions32 takes exclusive control over the game loop until the transition has completed.

nextTick

uint32 Sci::PlaneShowStyle::nextTick

The time at which the next step of the animation should execute.

currentStep

int Sci::PlaneShowStyle::currentStep

During playback of the show style, the current step (out of divisions).

processed

bool Sci::PlaneShowStyle::processed

Whether or not this style has finished running and is ready for disposal.

screenItems

Common::Array<ScreenItem *> Sci::PlaneShowStyle::screenItems

A list of screen items, each representing one block of a wipe transition. These screen items are owned by GfxFrameout.

numEdges

uint8 Sci::PlaneShowStyle::numEdges

For wipe transitions, the number of edges with a moving wipe (1, 2, or 4).

width

int16 Sci::PlaneShowStyle::width

The dimensions of the plane, in game script coordinates.

bitmapScreenItem

ScreenItem* Sci::PlaneShowStyle::bitmapScreenItem

For pixel dissolve transitions, the screen item used to render the transition. This screen item is owned by GfxFrameout.

bitmap

reg_t Sci::PlaneShowStyle::bitmap

For pixel dissolve transitions, the bitmap used to render the transition.

dissolveMask

uint32 Sci::PlaneShowStyle::dissolveMask

The bit mask used by pixel dissolve transitions.

firstPixel

uint32 Sci::PlaneShowStyle::firstPixel

The first pixel that was dissolved in a pixel dissolve transition.

pixel

uint32 Sci::PlaneShowStyle::pixel

The last pixel that was dissolved. Once all pixels have been dissolved, pixel will once again equal firstPixel.

fadeColorRanges

Common::Array<uint16> Sci::PlaneShowStyle::fadeColorRanges

An array of palette indexes, in the order [ fromColor, toColor, ... ]. Only colors within this range are transitioned.

---

The documentation for this struct was generated from the following file:

• engines/sci/graphics/transitions32.h