Skip to content

Plugin API 1.1 参考 ​

Plugin API 1.1 是 .splug 当前可以使用的公开契约。可以在运行时查询能力:

lua
if samp.api.has("entity.list", "1.1") then
    -- 使用该能力
end
命名空间用途
samp.api版本和能力查询。
samp.log带插件归属的日志。
samp.events事件订阅。
samp.timer、samp.task有界延迟任务。
samp.storage私有持久化。
samp.format有界数字格式化。
samp.game、samp.server只读状态快照。
samp.player带世代校验的本地玩家 Handle。
samp.entity已流入服务器实体。
samp.ui、samp.draw设置菜单与 HUD。
samp.effects、samp.physics可恢复的受控效果。

any 能力通常可在初始化和受保护回调使用;managed 只能在托管回调使用;hud 只能在 draw.hud 使用。

详细签名分别见核心运行环境、本地玩家与车辆、 服务器实体、菜单与 HUD 绘制、 效果与物理以及完整事件回调参数。 权限与运行限制同样属于 API 1.1 正式契约。

同一 major 版本内的 minor 版本只追加能力。当前客户端同时兼容精确的 1.0、^1.0、1.1 和 ^1.1;需要 1.1 新能力的插件应声明 ^1.1, 可选能力则应使用 samp.api.has() 查询。

Capability 契约 ​

能力权限调用阶段
api.has无需权限any
log无需权限any
events.on无需权限any
event.plugin.loaded无需权限any
event.plugin.unloading无需权限any
event.game.ready无需权限any
event.game.frame无需权限any
event.session.started无需权限any
event.session.ended无需权限any
event.server.connected无需权限any
event.server.disconnected无需权限any
event.player.spawned无需权限any
event.player.died无需权限any
event.player.damage_beforegame.player.writeany
event.player.health_changedgame.player.readany
event.player.vehicle_enteredgame.vehicle.readany
event.player.vehicle_leftgame.vehicle.readany
event.player.interior_changedgame.state.readany
event.player.weapon_changedgame.player.readany
event.player.aiming_changedgame.player.readany
event.player.motion_changedgame.player.readany
event.player.vehicle_collisiongame.vehicle.readany
event.player.skin_changedgame.player.readany
event.player.animation_changedgame.player.readany
event.player.task_changedgame.player.readany
event.world.time_changedgame.state.readany
event.world.weather_changedgame.state.readany
event.vehicle.health_changedgame.vehicle.readany
event.vehicle.state_changedgame.vehicle.readany
event.chat.message_receivedchat.readany
event.chat.server_message_receivedchat.readany
event.chat.bubble_receivedchat.readany
event.checkpoint.enteredgame.state.readany
event.checkpoint.leftgame.state.readany
event.ui.menu_openedui.menuany
event.ui.menu_closedui.menuany
event.ui.control_changedui.menuany
event.input.touchui.inputany
event.camera.mode_changedgame.state.readany
event.draw.hudui.drawhud
event.network.packet_receivednetwork.inspectany
event.network.rpc_receivednetwork.inspectany
event.network.packet_sendingnetwork.inspectany
event.network.rpc_sendingnetwork.inspectany
event.network.packet_before_sendnetwork.interceptany
event.network.rpc_before_sendnetwork.interceptany
event.entity.streamed_ingame.entity.readany
event.entity.streamed_outgame.entity.readany
event.pickup.collectedgame.entity.readany
event.chat.message_sendingchat.interceptany
event.command.executingcommand.interceptany
event.dialog.showndialog.readany
event.dialog.respondingdialog.interceptany
event.textdraw.showntextdraw.readany
event.textdraw.hiddentextdraw.readany
event.textdraw.text_changedtextdraw.readany
event.textdraw.clickingtextdraw.interceptany
timer.after无需权限any
task.spawn无需权限any
task.sleep无需权限any
storage.getplugin.storageany
storage.setplugin.storageany
storage.removeplugin.storageany
format.number无需权限any
game.stategame.state.readany
world.timegame.state.readany
world.weathergame.state.readany
checkpoint.stategame.state.readany
camera.stategame.state.readany
network.statsnetwork.stats.readany
audio.playaudio.playbackany
audio.stopaudio.playbackany
audio.stateaudio.playbackany
server.currentserver.state.readany
chat.notifyui.chatany
chat.sendchat.sendany
command.sendchat.sendany
clipboard.getui.clipboard.readany
clipboard.setui.clipboard.writeany
ui.menu.registerui.menuany
draw.textui.drawhud
draw.lineui.drawhud
draw.rectui.drawhud
draw.imageui.drawhud
draw.circleui.drawhud
draw.progress_barui.drawhud
draw.world_to_screenui.drawhud
player.local_playergame.player.readany
player.is_validgame.player.readany
player.positiongame.player.readany
player.healthgame.player.readany
player.armorgame.player.readany
player.velocitygame.player.readany
player.weapongame.player.readany
player.aimgame.player.readany
player.motiongame.player.readany
player.skingame.player.readany
player.animationgame.player.readany
player.taskgame.player.readany
player.vehiclegame.vehicle.readany
vehicle.is_validgame.vehicle.readany
vehicle.positiongame.vehicle.readany
vehicle.healthgame.vehicle.readany
vehicle.velocitygame.vehicle.readany
vehicle.stategame.vehicle.readany
vehicle.seatgame.vehicle.readany
vehicle.occupantsgame.vehicle.readany
entity.getgame.entity.readany
entity.listgame.entity.readany
entity.is_validgame.entity.readany
entity.positiongame.entity.readany
entity.player.namegame.entity.readany
entity.player.npcgame.entity.readany
entity.player.stategame.entity.readany
entity.player.healthgame.entity.readany
entity.player.armorgame.entity.readany
entity.player.vehicle_idgame.entity.readany
entity.player.statsgame.entity.readany
entity.vehicle.modelgame.entity.readany
entity.vehicle.healthgame.entity.readany
entity.vehicle.velocitygame.entity.readany
entity.vehicle.headinggame.entity.readany
entity.object.modelgame.entity.readany
entity.object.rotationgame.entity.readany
entity.object.movinggame.entity.readany
entity.object.attachmentgame.entity.readany
entity.actor.modelgame.entity.readany
entity.actor.healthgame.entity.readany
entity.actor.invulnerablegame.entity.readany
entity.actor.headinggame.entity.readany
entity.pickup.modelgame.entity.readany
entity.pickup.pickup_typegame.entity.readany
entity.text_label.textgame.entity.readany
entity.text_label.colorgame.entity.readany
entity.text_label.draw_distancegame.entity.readany
entity.text_label.test_losgame.entity.readany
entity.text_label.attachmentgame.entity.readany
player.set_healthgame.player.writemanaged
player.set_armorgame.player.writemanaged
player.set_positiongame.player.writemanaged
player.set_velocitygame.player.writemanaged
player.set_skingame.player.writemanaged
player.set_weapongame.player.writemanaged
player.set_ammogame.player.writemanaged
vehicle.set_healthgame.vehicle.writemanaged
vehicle.set_positiongame.vehicle.writemanaged
vehicle.set_velocitygame.vehicle.writemanaged
effects.acquire无需权限managed
effects.group无需权限any
effects.release无需权限managed
effects.player.physics_flagsgame.physics.overridemanaged
effects.player.collision_filtergame.physics.overridemanaged
effects.camera.followgame.camera.controlmanaged
physics.create_surfacegame.physics.overridemanaged
surface.is_validgame.physics.overrideany
surface.set_positiongame.physics.overridemanaged
surface.releasegame.physics.overridemanaged
require无需权限any