Main Page: Difference between revisions
Jump to navigation
Jump to search
Update G1R:MP 0.1.2 API documentation |
Add G1R:MP 0.1.2 navigation API |
||
| Line 10: | Line 10: | ||
<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;"> | <div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;"> | ||
<div style="color:#111; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">AVAILABLE AND IMPROVED FROM UPDATE 0.1.2</div> | <div style="color:#111; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">AVAILABLE AND IMPROVED FROM UPDATE 0.1.2</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.55;">The following ''' | <div style="color:#111; margin-top:0.35rem; line-height:1.55;">The following '''29 server-side Lua functions''' are available from G1R:MP 0.1.2. Existing lifecycle, inventory, JSON, NPC, monster, and world-item APIs also include corrected or expanded behavior from this update.</div> | ||
<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Accounts and consumables (4):</strong> [[completePlayerConsumableFinalize]] • [[completePlayerConsumableUse]] • [[getPlayerAccountBindingSerial]] • [[getPlayerConsumableNames]]</div> | <div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Accounts and consumables (4):</strong> [[completePlayerConsumableFinalize]] • [[completePlayerConsumableUse]] • [[getPlayerAccountBindingSerial]] • [[getPlayerConsumableNames]]</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>World items (1):</strong> [[spawnItem]] — see also the [[World item catalog]].</div> | <div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>World items (1):</strong> [[spawnItem]] — see also the [[World item catalog]].</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster identity, health, and combat (5):</strong> [[setMonsterName]] • [[setMonsterIdVisible]] • [[setMonsterMaxHealth]] • [[getMonsterAttackDamage]] • [[setMonsterAttackDamage]]</div> | <div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster identity, health, and combat (5):</strong> [[setMonsterName]] • [[setMonsterIdVisible]] • [[setMonsterMaxHealth]] • [[getMonsterAttackDamage]] • [[setMonsterAttackDamage]]</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster navigation ( | <div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster navigation (6):</strong> [[setMonsterNavigationMode]] • [[setMonsterNavigationCollisionMode]] • [[setMonsterMoveGoal]] • [[stopMonsterMovement]] • [[testMonsterMove]] • [[walkMonsterTo]]</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>NPC identity and navigation ( | <div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>NPC identity and navigation (7):</strong> [[setNpcIdVisible]] • [[setNpcObstacleBehavior]] • [[setNpcNavigationMode]] • [[setNpcNavigationCollisionMode]] • [[setNpcMoveGoal]] • [[stopNpcMovement]] • [[testNpcMove]]</div> | ||
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Custom navigation blockers (6):</strong> [[createAiNavigationBlocker]] • [[updateAiNavigationBlocker]] • [[setAiNavigationBlockerEnabled]] • [[destroyAiNavigationBlocker]] • [[getAiNavigationBlockerData]] • [[getAiNavigationBlockers]] — see [[NPC and monster navigation collision]].</div> | |||
<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Events available from 0.1.2 (8):</strong> [[onNpcIdVisibilityChange]] • [[onMonsterNameChange]] • [[onMonsterIdVisibilityChange]] • [[onMonsterMoveBlocked]] • [[onMonsterMoveComplete]] • [[onNpcMoveBlocked]] • [[onNpcMoveComplete]] • [[onWorldItemDrop]]. Existing [[onPlayerJoin]], [[onPlayerQuit]], [[onWorldItemPickup]], and [[onWorldItemSpawn]] contracts are also improved from 0.1.2.</div> | <div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Events available from 0.1.2 (8):</strong> [[onNpcIdVisibilityChange]] • [[onMonsterNameChange]] • [[onMonsterIdVisibilityChange]] • [[onMonsterMoveBlocked]] • [[onMonsterMoveComplete]] • [[onNpcMoveBlocked]] • [[onNpcMoveComplete]] • [[onWorldItemDrop]]. Existing [[onPlayerJoin]], [[onPlayerQuit]], [[onWorldItemPickup]], and [[onWorldItemSpawn]] contracts are also improved from 0.1.2.</div> | ||
| Line 30: | Line 31: | ||
<li>[[Lua events|Complete event and callback catalog]]</li> | <li>[[Lua events|Complete event and callback catalog]]</li> | ||
<li>[[Lua API catalogs|Validated skin, monster, equipment, and gameplay keys]]</li> | <li>[[Lua API catalogs|Validated skin, monster, equipment, and gameplay keys]]</li> | ||
<li>[[NPC and monster navigation collision|NPC and monster navigation collision]]</li> | |||
<li>[[:Category:Resource Functions|Resource lifecycle functions]]</li> | <li>[[:Category:Resource Functions|Resource lifecycle functions]]</li> | ||
<li>[[:Category:Lua Examples|Lua examples]]</li> | <li>[[:Category:Lua Examples|Lua examples]]</li> | ||
| Line 65: | Line 67: | ||
<div>[[:Category:World Functions|World time and weather]]</div> | <div>[[:Category:World Functions|World time and weather]]</div> | ||
<div>[[:Category:Monster Functions|Monsters]]</div> | <div>[[:Category:Monster Functions|Monsters]]</div> | ||
<div>[[:Category:Navigation Functions|AI navigation]]</div> | |||
<div>[[:Category:Interaction Functions|Interactions]]</div> | <div>[[:Category:Interaction Functions|Interactions]]</div> | ||
</div> | </div> | ||
| Line 111: | Line 114: | ||
<div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;"> | <div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;"> | ||
<div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div> | <div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div> | ||
<div style="line-height:1.6;">The reference contains '''236 Lua functions from earlier releases''' plus ''' | <div style="line-height:1.6;">The reference contains '''236 Lua functions from earlier releases''' plus '''29 functions introduced in update 0.1.2'''. It also contains '''80 events from earlier releases''' plus '''8 events introduced in update 0.1.2'''. Selected existing pages carry an '''improved from 0.1.2''' marker where their contract changed. See [[Lua API catalogs]] for validated skin, monster, equipment, progression, and gameplay keys. APIs marked [[:Category:Experimental Lua API|experimental]] have validated contracts but may still change while the multiplayer runtime is under active development.</div> | ||
</div> | </div> | ||
</div> | </div> | ||
[[Category:Lua API]] | [[Category:Lua API]] | ||
Revision as of 13:52, 4 September 2026
Gothic 1 Remake Multiplayer
G1R:MP Scripting Wiki
Build multiplayer resources and gamemodes with Lua 5.1. This wiki documents the server, client, networking, gameplay, database, and RmlUi APIs exposed by G1R:MP.
Lua 5.1 • server and client resources • authoritative gameplay • RmlUi
AVAILABLE AND IMPROVED FROM UPDATE 0.1.2
The following 29 server-side Lua functions are available from G1R:MP 0.1.2. Existing lifecycle, inventory, JSON, NPC, monster, and world-item APIs also include corrected or expanded behavior from this update.
Accounts and consumables (4): completePlayerConsumableFinalize • completePlayerConsumableUse • getPlayerAccountBindingSerial • getPlayerConsumableNames
World items (1): spawnItem — see also the World item catalog.
Monster identity, health, and combat (5): setMonsterName • setMonsterIdVisible • setMonsterMaxHealth • getMonsterAttackDamage • setMonsterAttackDamage
Monster navigation (6): setMonsterNavigationMode • setMonsterNavigationCollisionMode • setMonsterMoveGoal • stopMonsterMovement • testMonsterMove • walkMonsterTo
NPC identity and navigation (7): setNpcIdVisible • setNpcObstacleBehavior • setNpcNavigationMode • setNpcNavigationCollisionMode • setNpcMoveGoal • stopNpcMovement • testNpcMove
Custom navigation blockers (6): createAiNavigationBlocker • updateAiNavigationBlocker • setAiNavigationBlockerEnabled • destroyAiNavigationBlocker • getAiNavigationBlockerData • getAiNavigationBlockers — see NPC and monster navigation collision.
Events available from 0.1.2 (8): onNpcIdVisibilityChange • onMonsterNameChange • onMonsterIdVisibilityChange • onMonsterMoveBlocked • onMonsterMoveComplete • onNpcMoveBlocked • onNpcMoveComplete • onWorldItemDrop. Existing onPlayerJoin, onPlayerQuit, onWorldItemPickup, and onWorldItemSpawn contracts are also improved from 0.1.2.
Start here
Find the right entry point for your first resource.
Reference by execution side
Check where a function is available before using it.
Gameplay
Scripting systems
Your first server script
The following example welcomes a joining player and places them at an authoritative spawn point:
addEventHandler("onPlayerJoin", root, function(playerId)
setPlayerName(playerId, "Newcomer")
spawnPlayer(playerId, 12.0, 24.0, 2.0, 90)
outputChatBox("Welcome to G1R:MP!", playerId, 225, 195, 110)
end)
See onPlayerJoin, addEventHandler, setPlayerName, spawnPlayer, and outputChatBox for parameter details and additional examples.
Documentation status
The reference contains 236 Lua functions from earlier releases plus 29 functions introduced in update 0.1.2. It also contains 80 events from earlier releases plus 8 events introduced in update 0.1.2. Selected existing pages carry an improved from 0.1.2 marker where their contract changed. See Lua API catalogs for validated skin, monster, equipment, progression, and gameplay keys. APIs marked experimental have validated contracts but may still change while the multiplayer runtime is under active development.