Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

UE1:Canvas (UT)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT Object >> Canvas

Contents

Package: 
Engine
This class in other games:
RTNP, U1, U2, U2XMP, UDK, UE2Runtime, UT2003, UT2004, 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.

[edit] Properties

[edit] bCenter

Type: bool

Whether to center the text.

[edit] BigFont

Type: Font

Big system font.

Default value: Font'Engine.BigFont'

[edit] bNoSmooth

Type: bool

Don't bilinear filter.

[edit] ClipX

Type: float


[edit] ClipY

Type: float

Bottom right clipping region.

[edit] CurX

Type: float


[edit] CurY

Type: float

Current position for drawing.

[edit] CurYL

Type: float

Largest Y size since DrawText.

[edit] DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member Value
B 127
G 127
R 127

[edit] Font

Type: Font

Font for DrawText.

[edit] FramePtr

Type: int

Modifiers: const

Scene frame pointer.

[edit] LargeFont

Type: Font


Default value: Font'Engine.LargeFont'

[edit] MedFont

Type: Font

Medium system font.

Default value: Font'Engine.MedFont'

[edit] OrgX

Type: float


[edit] OrgY

Type: float

Origin for drawing.

[edit] RenderPtr

Type: int

Modifiers: const


[edit] SizeX

Type: int

Modifiers: const


[edit] SizeY

Type: int

Modifiers: const


[edit] SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

[edit] SpaceX

Type: float


[edit] SpaceY

Type: float

Spacing for after Draw*.

[edit] Style

Type: byte

Drawing style STY_None means don't draw.

Default value: 1

[edit] Viewport

Type: Viewport

Modifiers: const

Viewport that owns the canvas.

[edit] Z

Type: float

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

Default value: 1.0

[edit] Functions

[edit] Native functions

[edit] DrawActor

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


[edit] DrawClippedActor

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


[edit] 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)


[edit] DrawText

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


[edit] DrawTextClipped

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


[edit] DrawTile

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


[edit] DrawTileClipped

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


[edit] StrLen

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


[edit] TextSize

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


[edit] Events

[edit] Reset

event Reset ()


[edit] Other instance functions

[edit] DrawIcon

final function DrawIcon (Texture Tex, float Scale)


[edit] DrawPattern

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


[edit] DrawRect

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


[edit] SetClip

final function SetClip (float X, float Y)


[edit] SetOrigin

final function SetOrigin (float X, float Y)


[edit] SetPos

final function SetPos (float X, float Y)