Gah - a solution with more questions. – EntropicLqd

UE2:Canvas (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UE2Runtime Object >> Canvas
Package: 
Engine
This class in other games:
RTNP, U1, UT, U2, U2XMP, 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[edit]

bCenter[edit]

Type: bool

Whether to center the text.

bNoSmooth[edit]

Type: bool

Don't bilinear filter.

ClipX[edit]

Type: float


ClipY[edit]

Type: float

Bottom right clipping region.

CurX[edit]

Type: float

The canvas current drawing position in the X Axis (Left to Right)

CurY[edit]

Type: float

The canvas current drawing position in the Y Axis (Top to Bottom)

CurYL[edit]

Type: float

Largest Y size since DrawText.

DrawColor[edit]

Type: Object.Color

Color for drawing.

Default value:

Member Value
A 255
B 127
G 127
R 127

Font[edit]

Type: Font

Font for DrawText.

Default value: Font'Engine.DefaultFont'

MedFont[edit]

Type: Font


MedFontName[edit]

Type: string


Default value: "EM_Fonts_T.FontMono800x600"

OrgX[edit]

Type: float


OrgY[edit]

Type: float

Origin for drawing.

pCanvasUtil[edit]

Type: int

Modifiers: const


SizeX[edit]

Type: int

Modifiers: const

The screen size in X Axis

SizeY[edit]

Type: int

Modifiers: const

The screen size in Y Axis

SmallFont[edit]

Type: Font


SmallFontName[edit]

Type: string


Default value: "EM_Fonts_T.FontMono"

SpaceX[edit]

Type: float


SpaceY[edit]

Type: float

Spacing for after Draw*.

Style[edit]

Type: byte

Drawing style STY_None means don't draw.

Default value: 1

TinyFont[edit]

Type: Font


TinyFontName[edit]

Type: string


Default value: "EM_Fonts_T.FontMono"

Viewport[edit]

Type: Viewport

Modifiers: const

Viewport that owns the canvas.

Z[edit]

Type: float

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

Default value: 1.0

Functions[edit]

Static functions[edit]

MakeColor[edit]

static final function Object.Color MakeColor (byte R, byte G, byte B, optional byte A)

Make a color with the input Red, Green and Blue levels

Native functions[edit]

DrawActor[edit]

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

Draw the the input actor with the other parameters. if WireFrame=True, the actor will be draw normaly but with another wireframe model around it. if ClearZ=True, the actor will be draw in front of everything. DisplayFOV is the FOV Angle of drawing.

DrawPortal[edit]

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

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

Draw a text.

DrawTextClipped[edit]

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


DrawTextJustified[edit]

native final function DrawTextJustified (coerce string String, byte Justification, float x1, float y1, float x2, float y2)


DrawTile[edit]

native(466) final function DrawTile (Material Mat, float XL, float YL, float U, float V, float UL, float VL)


DrawTileClipped[edit]

native(468) final function DrawTileClipped (Material Mat, float XL, float YL, float U, float V, float UL, float VL)


DrawTileJustified[edit]

native final function DrawTileJustified (Material Mat, byte Justification, float XL, float YL)


DrawTileScaled[edit]

native final function DrawTileScaled (Material Mat, float XScale, float YScale)


DrawTileStretched[edit]

native final function DrawTileStretched (Material Mat, float XL, float YL)


StrLen[edit]

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


TextSize[edit]

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


WrapStringToArray[edit]

native final function WrapStringToArray (string Text, out array<stringOutArray, float dx, string EOL)


Events[edit]

Reset[edit]

event Reset ()

Reset all canvas variables to their defaults

Other instance functions[edit]

DrawBox[edit]

final simulated function DrawBox (Canvas canvas, float width, float height)

Draw a box. width is the box size in the X Axis and height is the size in Y Axis.

DrawBracket[edit]

final simulated function DrawBracket (float width, float height, float bracket_size)


DrawHorizontal[edit]

final function DrawHorizontal (float Y, float width)


DrawIcon[edit]

final function DrawIcon (Texture Tex, float Scale)

Draw a scaled image.

DrawLine[edit]

final function DrawLine (int direction, float size)


DrawPattern[edit]

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


DrawRect[edit]

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


DrawVertical[edit]

final function DrawVertical (float X, float height)

Draw a vertical line(Y Axis)

SetClip[edit]

final function SetClip (float X, float Y)


SetDrawColor[edit]

final function SetDrawColor (byte R, byte G, byte B, optional byte A)


SetOrigin[edit]

final function SetOrigin (float X, float Y)


SetPos[edit]

final function SetPos (float X, float Y)