Z-finder: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 25: Line 25:


==API Version==
==API Version==
z-finder is built for API 1.2 of npcclient
1.2

Revision as of 05:58, 6 May 2023

This library is used to get the ground z co-ordinate for the npc to walk. It relies on 16 MB file default.map ( vice city map ). z-finder is ported from Miami-Scale plugin of server.

Functions

Return value Function Name Parameter Description
true on success MiamiScale_Init [string] mapfile The full path to mapfile as parameter
true or null MiamiScale_Unload -
float or null. FindZFor2DCoord integer]x, [float\|integer]y The x,y co-ordinates to find the corresponding z. Return value null means z does not exist - it might be sea or something.
float or null FindAverageZ integer]x, [float\|integer]y same as above
true on success SetZFor2DCoord [integer]x, [integer]y, [float]z Sets the z co-ordinate for a certain pair of integer x,y co-ordinates. Setting means subsequent get will fetch this value.
true on success MiamiScale_SaveCurrentMap [string]filename Saves the current map which might have changes resulting from function mentioned in above row.

Map File

You can download default.map here

Links

Windows: z-finder.dll

API Version

1.2