Mostly Harmless

UE1:Canvas (UT)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT Object >> Canvas
Package: 
Engine
This class in other games:
RTNP, U1, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK, UT3

Canvas: A drawing canvas. This is a built-in Unreal class and it shouldn't be modified.

Notes. To determine size of a drawable object, set Style to STY_None, remember CurX, draw the thing, then inspect CurX and CurYL.

Properties

bCenter

Type: bool

Whether to center the text.

BigFont

Type: Font

Big system font.

Default value: Font'Engine.BigFont'

bNoSmooth

Type: bool

Don't bilinear filter.

ClipX

Type: float


ClipY

Type: float

Bottom right clipping region.

CurX

Type: float


CurY

Type: float

Current position for drawing.

CurYL

Type: float

Largest Y size since DrawText.

DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member Value
B 127
G 127
R 127

Font

Type: Font

Font for DrawText.

FramePtr

Type: int

Modifiers: const

Scene frame pointer.

LargeFont

Type: Font


Default value: Font'Engine.LargeFont'

MedFont

Type: Font

Medium system font.

Default value: Font'Engine.MedFont'

OrgX

Type: float


OrgY

Type: float

Origin for drawing.

RenderPtr

Type: int

Modifiers: const


SizeX

Type: int

Modifiers: const


SizeY

Type: int

Modifiers: const


SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

SpaceX

Type: float


SpaceY

Type: float

Spacing for after Draw*.

Style

Type: byte

Drawing style STY_None means don't draw.

Default value: 1

Viewport

Type: Viewport

Modifiers: const

Viewport that owns the canvas.

Z

Type: float

Z location. 1=no screenflash, 2=yes screenflash.

Default value: 1.0

Functions

Native functions

DrawActor

native(467) final function DrawActor (Actor A, bool WireFrame, optional bool ClearZ)


DrawClippedActor

native(471) final function DrawClippedActor (Actor A, bool WireFrame, int X, int Y, int XB, int YB, optional bool ClearZ)


DrawPortal

native(480) final function DrawPortal (int X, int Y, int Width, int Height, Actor CamActor, Object.Vector CamLocation, Object.Rotator CamRotation, optional int FOV, optional bool ClearZ)


DrawText

native(465) final function DrawText (coerce string Text, optional bool CR)


DrawTextClipped

native(469) final function DrawTextClipped (coerce string Text, optional bool bCheckHotKey)


DrawTile

native(466) final function DrawTile (Texture Tex, float XL, float YL, float U, float V, float UL, float VL)


DrawTileClipped

native(468) final function DrawTileClipped (Texture Tex, float XL, float YL, float U, float V, float UL, float VL)


StrLen

native(464) final function StrLen (coerce string String, out float XL, out float YL)


TextSize

native(470) final function TextSize (coerce string String, out float XL, out float YL)


Events

Reset

event Reset ()


Other instance functions

DrawIcon

final function DrawIcon (Texture Tex, float Scale)


DrawPattern

final function DrawPattern (Texture Tex, float XL, float YL, float Scale)


DrawRect

final function DrawRect (Texture Tex, float RectX, float RectY)


SetClip

final function SetClip (float X, float Y)


SetOrigin

final function SetOrigin (float X, float Y)


SetPos

final function SetPos (float X, float Y)