Tool interface

Functions
string	do_work (player_x pl, coord3d start, coord3d end, int keys)
void	mark_tiles (player_x pl, coord3d start, coord3d end, int keys)
string	work (player_x pl, coord3d pos, int keys)

Detailed Description

The following methods are vital for the functioning of scripted tools. They will be called from simutrans to interact with the script. You should consider implementing them.

Function Documentation

do_work()

string do_work	(	player_x	pl,
		coord3d	start,
		coord3d	end,
		int	keys
	)

Does the work (for tools of two-click type).

Returns

null upon success, an error message otherwise.

Parameters

pl	player instance to use this tool.
start	first tile clicked by user.
end	second tile clicked by user.
keys	state of ctrl/shift keys.

mark_tiles()

void mark_tiles	(	player_x	pl,
		coord3d	start,
		coord3d	end,
		int	keys
	)

Mark tiles for working (for tools of two-click type). Call mark_tile from here.

Parameters

pl	player instance to use this tool.
start	first tile clicked by user.
end	second tile clicked by user.
keys	state of ctrl/shift keys.

work()

string work	(	player_x	pl,
		coord3d	pos,
		int	keys
	)

Does the work (for tools of one-click type).

Returns

null upon success, an error message otherwise.

Parameters

pl	player instance to use this tool.
pos	tile clicked by user, here the work should be done.
keys	state of ctrl/shift keys.