sd_Text Reference

If you have any questions, suggestions, or problems for sd_Text please email me at shadowdarke@hotmail.com or post a message at http://shadowdarke.byond.com/forum/forum.cgi?forum=libraries

(Arguments in italics are optional)

Updates

version 9

version 8

global procs

sd_ImprovedWordBalloon proc

client procs

sd_TextWindow datum

read only vars (sd_TextWindow)

read/write vars (sd_TextWindow)

procs (sd_TextWindow)

New proc (sd_TextWindow)

Update proc (sd_TextWindow)

Append proc (sd_TextWindow)

AtomImage proc (sd_TextWindow)

Unframe proc (sd_TextWindow)

atom

var

sd_BalloonTails

movable

sd_BalloonTail movable atom: vars (sd_BalloonTail); sd_OwnerMoved proc (sd_BalloonTail)

Updates

Version 9

Added the new sd_ImprovedWordBalloon proc.

back to Contents

Version 8

Fixed a long standing bug that prevented sd_Text from working in worlds with very large maps.

back to Contents

Version 7

Added the fixedwidth and maxheight agruments to sd_WordBalloon(). A word balloon with fixed width will automatically wordwrap!

back to Contents

Version 6

Atom's displayed in an sd_TextWindow now show the correct icon_state, dir, and overlays of the original. The layer is correctly modified to display atom the text window.
Added a new hook in sd_TextWindow/Update() to customize atom icons in detail. See AtomImage proc (sd_TextWindow)

back to Contents

Version 5

The text in sd_WordBalloon() was drawn on FLY_LAYER, no matter what layer was assigned in the proc call.
sd_WordBalloon automatically cleared all word balloons attached to Owner each time it was called. I've realizd this is not always the desired case so that behaviour has been removed from the library. The demo in test.dm shows how to remove attached word balloons, if that is desired.
sd_WordBalloon now returns a reference to the sd_BalloonTail. See the new sd_BalloonTail reference entry for more information.
Supplying a delay of 0 or less in an sd_WordBalloon() call prevents automatic deletion of the Word Balloon.

back to Contents

Version 4

sd_Text released on BYONDscape.

back to Contents

sd_Text proc

See also:: sd_OverlayText proc

Format:: sd_Text(To, Text as text, Loc, Layer, line, offset, charset)

Arguments:

To:: person or list of people who will see the text images
Text:: text to display
Loc:: atom or list of atoms to display the Text on.
If Loc is a turf, text will automatically display on turfs to the right of Loc.
If Loc is a list, text will display on the atoms in the list with Loc[1] as the left edge and Loc[Loc.len] as the right edge.
Layer: graphics layer on which to display text
Default: Layer = FLY_LAYER
line: Which row to display the text on
0 = bottom half of the turf
!0 = top half of the turf
Default: line = 0
offset: initial offset (0-3) within the turf.
0 = far left 3 = far right
Default: offset = 0
charset: Icon file that contains the character font.
Examine the included 'charset.dmi' for the format.
Default: charset = 'charset.dmi'

Returns:: list of the images created

sd_Text draws text as a series of images on atoms. Since the text is stored as images, it can be displayed to your choice of clients and left invisible to others.

back to Contents

sd_OverlayText proc

See also:: sd_Text proc

Format:: sd_OverlayText(Text as text, Loc, Layer, line, offset, charset)

Arguments:

Text: text to display
Loc: atom or list of atoms to display the Text on.
Layer: graphics layer on which to display text
Default: Layer = FLY_LAYER
line: Which row to display the text on
0 = bottom half of the turf
!0 = top half of the turf
Default: line = 0
offset: initial offset (0-3) within the turf.
0 = far left 3 = far right
Default: offset = 0
charset: Icon file that contains the character font. The icon must have icon_states for each character.
Examine the included 'charset.dmi' for the format.
Default: charset = 'charset.dmi'

OverlayText draws text as overlays on atoms, this allows everyone to see the text.

back to Contents

sd_WordBalloon proc

See also:: sd_BalloonText proc; sd_BalloonTail movable atom

Format:: sd_WordBalloon(To, Text as text, atom/Owner, layer, delay, charset, balloon, rigid, fixedwidth, maxheight)
Arguments:

Returns:: The sd_BalloonTail created for the new Word Balloon.

sd_WordBalloon creates a mobile word balloon that will move to follow the Owner. The important balloon data is stored in an sd_BalloonTail and the sd_BalloonTail is stored in the Owner atom's sd_BalloonTails list.

back to Contents

sd_ImprovedWordBalloon proc

See also:: sd_WordBalloon proc; sd_BalloonText proc

Format:: sd_ImprovedWordBalloon(Text as text, atom/Owner, layer, delay, charset, balloon)
Arguments:

sd_ImprovedWordBalloon creates a mobile word balloon using the pixel offset vars. The sd_ImprovedWordBalloon takes less processor power when you move, and allows you to see the entire word balloon regardless of opaque obstructions.

back to Contents

sd_BalloonText proc

See also:: sd_WordBalloon proc

Format:: sd_BalloonText(Text as text, turf/Loc, delay, charset, balloon)
Arguments:

sd_BalloonText is an early form of sd_WordBalloon from the MapText library that creates immobile word balloons on turf's only. It is left in sd_Text library to ease conversion of programs from MapText to sd_Text. I strongly recommend using sd_WordBalloon.
sd_BalloonText combines sd_MapFrame and sd_Text to create word balloons visible to each mob within view() of Loc.

back to Contents

sd_MapFrame proc

See also:: sd_OverlayFrame proc

Format:: sd_MapFrame(To, Left, Right, Top, Bottom, Z, Layer, frame)
Arguments:
Returns:: list of the images created

sd_MapFrame draws a box as images on map turfs.

back to Contents

sd_OverlayFrame proc

See also:: sd_MapFrame proc

Format:
Arguments:

sd_OverlayFrame draws a box as overlays on map turfs, this allows
everyone to see the box.

back to Contents

sd_FontIndex proc

See also:: sd_RegisterFont proc

Format:: sd_FontIndex(Font as icon)
Arguments:
Returns:: Index number for a font in sd_FontRegistry.

sd_FontIndex returns the sd_FontRegistry index of a font. If the font is not found, it will be added to the registry.

back to Contents

sd_RegisterFont proc

See also:: sd_FontIndex proc

Format:: sd_RegisterFont(Font as icon)
Arguments:

sd_RegisterFont stores a font into the sd_FontRegistry so it may be accessed quickly by the text functions.

sd_RegisterFont is called automatically by the sd_Text procs if a font is not registered. You don't need to use it unless you want to pre-register a font before drawing text.

back to Contents

sd_Input proc

See also:: sd_TextWindow datum

Format:: sd_Input(atom/Client, list/List, X, Y, width, height, Selections, frame, Layer, charset, windowicon, scrollicon)
Arguments:
Returns:: If selections = 1 (default), returns the text or atom selected. Otherwise, sd_Input returns a list of all the selected text and/or atoms.

sd_Input displays a list of options in a text window on the client screen and lets the client select one or more items from the list.

sd_Input requires a mouse.

back to Contents

sd_ScreenHeight proc (client)

See also:: sd_ScreenWidth proc (client)

Format:: sd_ScreenHeight()
Returns:: The height, in tiles, of client.view

This proc returns the height of client.view, no matter if view is numeric or text.

back to Contents

sd_ScreenWidth proc (client)

See also:: sd_ScreenHeight proc (client)

Format:: client.sd_ScreenWidth()
Returns:: The width, in tiles, of client.view

This proc returns the width of client.view, no matter if view is numeric or text.

back to Contents

sd_TextWindow datum

See also:: read only vars (sd_TextWindow); read/write vars (sd_TextWindow); procs (sd_TextWindow)

The sd_TextWindow draws and maintains a client screen box for displaying scrolling text and/or atoms.

back to Contents

read only vars (sd_TextWindow)

See also:: sd_TextWindow datum; read/write vars (sd_TextWindow); procs (sd_TextWindow)

These vars provide information about an sd_TextWindow, but should never be overwritten manually or the window may not function properly.

client/Client: The client this window belongs to
X: Left boundry of the window
Y: Bottom boundry of the window
Layer: layer of the window display
height: height of the window
width: width of the window
Lines: List of text and/or atoms displayed in the window

back to Contents

read/write vars (sd_TextWindow)

See also:: sd_TextWindow datum; read only vars (sd_TextWindow); procs (sd_TextWindow)

These vars may be changed manually.

offset: offset in the Lines list to the top line currently displayed in the window. If you change offset, you should call Update() the window to display the change.
maxlines: maximum number of lines allowed in Lines. When maxlines is exceeded, the oldest line will be deleted. Setting maxlines less than Lines.len will not decrease the curretn number of lines, but will prevent it from increasing.
Default value: maxlines = 255
highlight: If set, the window will highlight and select lines if they are clicked.
select: List of selected line numbers. Selected lines are displayed with a highlight.

back to Contents

procs (sd_TextWindow)

See also:: sd_TextWindow datum; read only vars (sd_TextWindow); read/write vars (sd_TextWindow)

Built in sd_TextWindow procs:

sd_TextWindow/proc: New proc (sd_TextWindow); Append proc (sd_TextWindow); AtomImage proc (sd_TextWindow); Unframe proc (sd_TextWindow); Update proc (sd_TextWindow)

back to Contents

New proc (sd_TextWindow)

See also:: sd_TextWindow datum

Format:: New(atom/Client, X, Y, width, height, wordwrap, scroll, frame, highlight, maxlines, Layer, windowicon, scrollicon)
Arguments:

called when you create a new sd_TextWindow

back to Contents

Update proc (sd_TextWindow)

See also:: sd_TextWindow datum; AtomImage proc (sd_TextWindow)

Format:: Update()

Updates the window display.

back to Contents

Append proc (sd_TextWindow)

See also:: sd_TextWindow datum

Format:: Append(Line, charset, update)
Arguments:

Add a line of text or an atom to the window.

back to Contents

AtomImage proc (sd_TextWindow)

See also:: sd_TextWindow datum; Update proc (sd_TextWindow)

Format:: AtomImage(atom/A, atom/movable/M)
Arguments:
Default Action:: none

AtomImage() provides a hook in sd_TextWindow/Update() allowing the program to further customize the display of atom within an sd_TextWindow.

Example:

sd_TextWindow/AtomImage(atom/A, atom/movable/M)
	M.name = A.name 
	// name the window display the same as the original atom 
	if(istype(A,/obj/numbered)) // if A is a numbered obj
		var/obj/numbered/N = A // give it an alias
		// convert the number to text for sd_OverlayText
		var/Text = num2text(N.number)
		// put the text on the upper right of the icon
		sd_OverlayText(Text, M, Layer, 1, 4-lentext(Text))

back to Contents

Unframe proc (sd_TextWindow)

See also:: sd_TextWindow datum

Format:: Unframe(part as text)
Arguments:

remove all or part of the window frame.

back to Contents

sd_BalloonTails var (atom)

See also:: sd_BalloonTail movable atom

sd_BalloonTails is a list of all the BalloonTails attached to the atom.

back to Contents

sd_BalloonTail movable atom

See also:: sd_BalloonTails var (atom); vars (sd_BalloonTail); sd_OwnerMoved proc (sd_BalloonTail)

sd_BalloonTail corresponds to the tail of a word balloon. It keeps track of all the other parts of the word balloon and keeps it linked to the attached atom. When the tail is deleted, it destroys the rest of the word balloon automatically.

back to Contents

vars (sd_BalloonTail)

See also:: sd_BalloonTail movable atom
list/Balloon[]: list of movable atoms that make up this balloon
above: Keeps track of whether the balloon is above or below the owner.
1 = above the owner
-1 = below the owner
height: height (in tiles) of the balloon
width: width (in tiles) of the balloon
rigid: If 0, the tail will slide along the edge of the balloon, only moving the balloon if the tail moves beyond the edge. If 1, the balloon moves each time the Owner moves.
image/Image: image on the tail

back to Contents

sd_OwnerMoved proc (sd_BalloonTail)

See also:: sd_BalloonTail movable atom

Format:: sd_OwnerMoved(atom/movable/Owner)
Arguments:

sd_OwnerMoved is called automatically whenever the owner of the sd_BalloonTail calls the Move() proc. It updates the position of the tail and word balloon, changing the orientation of the balloon as necessary to keep it within the world boundries.

back to Contents