Skip to content

guislideshowctrl: members

16 implemented, 0 reserved. Entries are sorted by name.

guislideshowctrl.addrow(id: number) -> guislideshowentry

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Adds a row with that id at the end and returns it; set its image.

temp.row = Slides.addrow(1);
row.image = "slide1.png";

Specification: gui-legacy.md§24.

guislideshowctrl.animationtime: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Seconds a turn between rows takes (0.5); 0 turns at once.

Slides.animationtime = 0.25;

Specification: gui-legacy.md§24.

guislideshowctrl.clearrows() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Removes every row.

Slides.clearrows();

Specification: gui-legacy.md§24.

guislideshowctrl.getselectedrow() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The index of the selected row.

echo(Slides.getselectedrow());

Specification: gui-legacy.md§24.

guislideshowctrl.insertrow(index: number, id: number) -> guislideshowentry

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Inserts a row with that id at a position (the end when below 0 or past the end) and returns it.

temp.row = Slides.insertrow(0, 5);

Specification: gui-legacy.md§24.

guislideshowctrl.isendless: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Draws the rows round and round past both ends.

Slides.isendless = true;

Specification: gui-legacy.md§25.

guislideshowctrl.onAnimationEnd(index: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised when a turn ends, with the new row index.

function Slides.onAnimationEnd(index) {
echo(index);
}

Specification: gui-legacy.md§24.

guislideshowctrl.onAnimationStart(from: number, to: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised when a turn starts, with the current and the destination row index.

function Slides.onAnimationStart(from, to) {
echo(from @ " -> " @ to);
}

Specification: gui-legacy.md§24.

guislideshowctrl.overlayimage: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

A picture name kept with the control; the legacy client does not draw it.

Slides.overlayimage = "frame.png";

Specification: gui-legacy.md§25.

guislideshowctrl.removerow(index: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Removes the row at an index.

Slides.removerow(0);

Specification: gui-legacy.md§24.

guislideshowctrl.removerowbyid(id: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Removes the row with an id.

Slides.removerowbyid(5);

Specification: gui-legacy.md§24.

guislideshowctrl.rowcount() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The number of rows.

echo(Slides.rowcount());

Specification: gui-legacy.md§24.

guislideshowctrl.rows: guislideshowentry[]

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

The rows; each has an id and an image.

for (temp.r: Slides.rows)
echo(r.image);

Specification: gui-legacy.md§24.

guislideshowctrl.scrollonvisible: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Turns the wheel in from the next row when the control is shown (true).

Slides.scrollonvisible = false;

Specification: gui-legacy.md§25.

guislideshowctrl.selectedrow: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The index of the selected row; setting it turns to that row.

Slides.selectedrow = 2;

Specification: gui-legacy.md§24.

guislideshowctrl.setselectedrow(index: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Turns to a row (kept inside the rows).

Slides.setselectedrow(1);

Specification: gui-legacy.md§24.

Engine version 0.1.0. Built 2026-11-18.