Z-finder

From NPC for VCMP 0.4 Servers
Revision as of 17:54, 7 May 2023 by Habi (talk | contribs) (→‎Links)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

API Version

1.2

Note

In linux systems, the full name such as 'z-finder64.so' instead of 'z-finder' must be used while loading the library through ConnectNPC or ConnectNPCEx.