Skip to content

Conversation

itsneufox
Copy link
Contributor

@itsneufox itsneufox commented Aug 31, 2025

This PR is for the NPC component documentation

The open.mp branch for beta testing is here: openmultiplayer/open.mp#916

@itsneufox itsneufox requested a review from a team as a code owner August 31, 2025 16:23
@itsneufox
Copy link
Contributor Author

To any team member: don't merge it yet

@itsneufox
Copy link
Contributor Author

itsneufox commented Sep 5, 2025

TODO: Add deprecation notice on ConnectNPC

@itsneufox
Copy link
Contributor Author

Missing manual review by someone and nodes documentation

@itsneufox
Copy link
Contributor Author

itsneufox commented Sep 9, 2025

TODO:
- return values in vehicle related natives are wrong (0 instead of INVALID_VEHICLE_ID)
- Check seats ids

@dockfries
Copy link
Contributor

dockfries commented Oct 10, 2025

NPC_StartPlayback may usually specify the filename directly without suffix .rec, = npcmodes/recordings/${fileName}.rec
NPC_StartPlaybackEx with recordId can specify a complete path without suffix .rec? = npcmodes/recordings/${filePath+fileName}.rec. I'm not sure, I may wrong.

NPC_LoadRecord has a similar path problem.

https://github.com/openmultiplayer/open.mp/blob/b876feb66a7b8be4081125e873eb6657ac26109c/Server/Components/NPCs/NPC/npc.cpp#L91

For some deleted documents, links to other related should be removed, for example, OnNPCDisconnect should be changed to OnNPCDestroy etc..

callbacks/**/*.md ---> Related Functions error link, should be ../functions/***
function/**/*.md ---> Related Callbacks error link, should be ../callbacks/***

GetVehicleRotation.md -> Related funtions -> GetVehicleRotation -> GetVehicleRotationQuat.

All files need be format like prettier.

OnNPCEnter/ExitVehicle has been deleted, so NPC_ResetSurfingData need update, btw, are these two callbacks no longer available or missing?


What about some past APIs? Do those need to be changed or deleted?
For example, GetMyFacingAngle, GetMyPos, OnClientMessage, StartRecordingPlayback, StopRecordingPlayback, etc.

Dont forget global replace <VersionWarn version='omp v1.1.0.changemelater' /> after new version released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants