noiseXYZ/openmp-asf

openmp-asf

ASF - Additional Server Functions for open.mp Author: noiseXYZ

ASF is basically YSF for open.mp. It gives open.mp servers the YSF functions that open.mp does not have natively, with the same function names and parameters as YSF, so most YSF code compiles unchanged.

Why "ASF" and not YSF? It is YSF in all but name. The different name is only because I didn't want copyright issues with the YSF name. ASF contains no YSF source code: it is a new implementation of YSF's function list, written from scratch on top of Pawn.RakNet.

Made by noiseXYZ.

---

Why ASF exists

YSF works by patching the memory of the SA-MP server binary. open.mp is a different server, so YSF cannot load on it. open.mp already added most of YSF's getters as natives, but everything YSF did with packets (per-player names and skins, hiding players and objects, fake sync, fake ping, and so on) was missing.

ASF rebuilds those functions as a plain Pawn include. It rewrites, blocks and sends network packets through Pawn.RakNet, so no extra plugin is needed besides Pawn.RakNet.

Requirements

• open.mp server
• Pawn.RakNet 1.5 or newer (open.mp component or plugin), with its include Pawn.RakNet.inc
• open.mp compiler (pawncc 3.10.x) with the open.mp includes

Installation

1. Copy asf.inc into your pawno/include or qawno/include folder.
2. Include it after <open.mp> and <Pawn.RakNet>:

#include <open.mp>
#include <Pawn.RakNet>
#include <asf>

1. If you use pause.inc, remove it. ASF has its own pause tracking with the YSF names (IsPlayerPaused, GetPlayerPausedTime, OnPlayerPauseStateChange). If pause.inc is still included, ASF skips its pause functions and pause.inc keeps providing them.
2. Remove YSF.inc if it is in your script. ASF stops with an error if both are included.

Configuration

Define these before #include <asf> to change them:

ASF_VERSION and ASF_AUTHOR are defined by the include.

Functions

Per-player view (what one player sees of another)

ASF extras (not in YSF): ResetPlayerTeamForPlayer, ResetPlayerSkinForPlayer, ResetPlayerNameForPlayer, ResetPlayerFightStyleForPlayer, ResetPlayerPosForPlayer, ResetPlayerRotationQuatForPlayer, IsPlayerHiddenForPlayer.

Sync

type for UpdatePlayerSyncData: ASF_SYNC_AUTO (-1, by player state), ASF_SYNC_ONFOOT, ASF_SYNC_INCAR, ASF_SYNC_PASSENGER, ASF_SYNC_AIM.

Objects, vehicles, pickups, buildings

Network and server

SendRPC / SendData types: BS_BOOL, BS_CHAR, BS_UNSIGNEDCHAR, BS_SHORT, BS_UNSIGNEDSHORT, BS_INT, BS_UNSIGNEDINT, BS_FLOAT, BS_STRING (characters only: write the length first yourself if the RPC needs it).

Pause

Players in class selection or dead never count as paused.

Callbacks

public OnPlayerPauseStateChange(playerid, pausestate) {}          // 1 = paused, 0 = back
public OnPlayerStatsAndWeaponsUpdate(playerid) { return 1; }      // return 0 = drop the update
public OnOutcomeScmEvent(playerid, issuerid, E_SCM_EVENT_TYPE:eventid, vehicleid, arg1, arg2) { return 1; } // return 0 = block

Example

#include <open.mp>
#include <Pawn.RakNet>
#include <asf>

public OnPlayerCommandText(playerid, cmdtext[])
{
	if(!strcmp(cmdtext, "/disguise", true))
	{
		// everyone else sees this player as "Unknown" in skin 1
		for(new i = 0; i < MAX_PLAYERS; i++)
		{
			if(i == playerid || !IsPlayerConnected(i)) continue;
			SetPlayerNameForPlayer(i, playerid, "Unknown");
			SetPlayerSkinForPlayer(i, playerid, 1);
		}
		return 1;
	}
	return 0;
}

More in examples/example.pwn. tests/compile_test.pwn calls every function once and is used as the compile check.

Every YSF function and its status

Of the 347 functions and callbacks in YSF.inc:

• about 220 are already native in open.mp
• about 75 are added by ASF
• about 50 can't be done from Pawn

Already native in open.mp

You don't need ASF for these, open.mp has them:

• Server, names, bans: AddServerRule, SetServerRule, IsValidServerRule, AllowNickNameCharacter, IsNickNameCharacterAllowed, IsValidNickName, SetModeRestartTime, GetModeRestartTime, GetRunningTimers, ClearBanList, IsBanned, ToggleChatTextReplacement, ChatTextReplacementToggled, execute.
• Formatted messages (the normal natives take format arguments): SendClientMessagef, SendClientMessageToAllf, SendPlayerMessageToPlayerf, SendPlayerMessageToAllf, GameTextForPlayerf, GameTextForAllf, SendRconCommandf.
• Player: GetPlayerGravity, SetPlayerGravity, GetGravity, SetPlayerAdmin, GetPlayerRawIp, GetPlayerZAim, GetPlayerRotationQuat, GetPlayerWeather, GetPlayerSkillLevel, GetPlayerSirenState, GetPlayerLandingGearState, GetPlayerHydraReactorAngle, GetPlayerTrainSpeed, GetPlayerSurfingOffsets, GetPlayerSurfingPlayerObjectID, GetPlayerCameraTargetPlayerObj, IsPlayerCameraTargetEnabled, GetPlayerAttachedObject, GetPlayerBuildingsRemoved, GetPlayerDialogID, GetPlayerSpectateID, GetPlayerSpectateType, GetPlayerCheckpoint, GetPlayerRaceCheckpoint, IsPlayerCheckpointActive, IsPlayerRaceCheckpointActive, IsPlayerControllable, IsPlayerSpawned, IsPlayerInModShop, TogglePlayerWidescreen, IsPlayerWidescreenToggled, TogglePlayerGhostMode, GetPlayerGhostMode, GetPlayerConnectMode, GetSpawnInfo, GetPlayerClass, EditPlayerClass, GetAvailableClasses.
• Vehicles: GetVehicleSpawnInfo, SetVehicleSpawnInfo, GetVehicleColor, GetVehiclePaintjob, GetVehicleInterior, GetVehicleNumberPlate, GetVehicleRespawnDelay, SetVehicleRespawnDelay, GetVehicleRespawnTick, GetVehicleOccupiedTick, HasVehicleBeenOccupied, IsVehicleOccupied, IsVehicleDead, GetVehicleLastDriver, GetVehicleCab, GetVehicleMatrix, GetVehicleModelCount, GetVehicleModelsUsed, IsValidVehicle, IsVehicleSirenEnabled, ToggleVehicleSirenEnabled, SetVehicleParamsSirenState.
• Objects: GetObjectDrawDistance, GetObjectMoveSpeed, SetObjectMoveSpeed, GetObjectTarget, GetObjectAttachedData, GetObjectAttachedOffset, GetObjectSyncRotation, GetObjectMaterial, GetObjectMaterialText, IsObjectMaterialSlotUsed, IsObjectNoCameraCol, GetObjectType, the matching GetPlayerObject* / IsPlayerObject* functions, SetPlayerObjectMoveSpeed, AttachPlayerObjectToObject.
• Pickups: CreatePlayerPickup, DestroyPlayerPickup, IsValidPickup, IsValidPlayerPickup, GetPickupModel, SetPickupModel, GetPickupPos, SetPickupPos, GetPickupType, SetPickupType, GetPickupVirtualWorld, SetPickupVirtualWorld, the GetPlayerPickup* functions, ShowPickupForPlayer, HidePickupForPlayer, IsPickupStreamedIn, IsPlayerPickupStreamedIn, OnPickupStreamIn, OnPickupStreamOut, OnPlayerPickUpPlayerPickup.
• Gang zones: CreatePlayerGangZone, PlayerGangZoneShow, PlayerGangZoneHide, PlayerGangZoneFlash, PlayerGangZoneStopFlash, PlayerGangZoneDestroy, PlayerGangZoneGetColor, PlayerGangZoneGetFlashColor, PlayerGangZoneGetPos, IsPlayerGangZoneVisible, IsPlayerGangZoneFlashing, GangZoneGetPos, GangZoneGetColorForPlayer, GangZoneGetFlashColorForPlayer, IsGangZoneVisibleForPlayer, IsGangZoneFlashingForPlayer, IsPlayerInGangZone, IsPlayerInPlayerGangZone, IsValidGangZone, IsValidPlayerGangZone, OnPlayerEnterGangZone, OnPlayerLeaveGangZone, OnPlayerEnterPlayerGangZone, OnPlayerLeavePlayerGangZone.
• Textdraws: every TextDrawGet* / TextDrawIs* and PlayerTextDrawGet* / PlayerTextDrawIs* function, TextDrawSetPos, PlayerTextDrawSetPos, TextDrawSetStringForPlayer, IsTextDrawVisibleForPlayer, IsPlayerTextDrawVisible, IsValidTextDraw, IsValidPlayerTextDraw.
• 3D labels, menus, actors, weapons: every Get3DTextLabel* / GetPlayer3DTextLabel* function, Is3DTextLabelStreamedIn, IsValid3DTextLabel, IsValidPlayer3DTextLabel, GetMenuColumnHeader, GetMenuColumnWidth, GetMenuColumns, GetMenuItem, GetMenuItems, GetMenuPos, IsMenuDisabled, IsMenuRowDisabled, GetActorSkin, GetActorAnimation, GetActorSpawnInfo, GetWeaponSlot.

Added by ASF

SetPlayerTeamForPlayer, GetPlayerTeamForPlayer, SetPlayerSkinForPlayer, GetPlayerSkinForPlayer, SetPlayerNameForPlayer, GetPlayerNameForPlayer, SetPlayerFightStyleForPlayer, GetPlayerFightStyleForPlayer, SetPlayerPosForPlayer, SetPlayerRotationQuatForPlayer, ApplyAnimationForPlayer (YSF marked it "doesn't work", ASF's works), SetPlayerChatBubbleForPlayer, ResetPlayerMarkerForPlayer, ShowPlayerForPlayer, HidePlayerForPlayer, AddPlayerForPlayer, RemovePlayerForPlayer, SpawnForWorld, SendPlayerDeath, BroadcastDeath, SendBulletData, SetPlayerDisabledKeysSync, GetPlayerDisabledKeysSync, GetPlayerLastSyncedVehicleID, GetPlayerLastSyncedTrailerID, GetPlayerSyncWeapon, SetPlayerSyncKeys, SetPlayerSyncPos, SetPlayerSyncPosition, SetPlayerSyncVelocity, SetPlayerSyncRotationQuat, SetPlayerSyncCameraFrontVector, SetPlayerSyncCameraPos, SetPlayerSyncCameraMode, SetPlayerSyncWeapon, SetPlayerSyncWeaponState, SetPlayerSyncSpecialAction, SetPlayerSyncHealth, SetPlayerSyncArmour, SetPlayerSyncVehicleId, SetPlayerSyncVehicleSeat, SetPlayerSyncVehiclePosition, SetPlayerSyncVehicleVelocity, SetPlayerSyncVehicleRotQuat, SetPlayerSyncVehicleHealth, SetPlayerSyncTrainSpeed, UpdatePlayerSyncData, HideObjectForPlayer, ShowObjectForPlayer, HideNewObjectsForPlayer, IsObjectHiddenForPlayer, NewObjectsHiddenForPlayer, HideVehicle, ShowVehicle, IsVehicleHidden, SetPickupForPlayer, IsBuildingRemovedForPlayer, SetExclusiveBroadcast, BroadcastToPlayer, TogglePlayerScoresPingsUpdate, TogglePlayerFakePing, SetPlayerFakePing, SendRPC, SendData, LoadFilterScript, UnLoadFilterScript, IsPlayerPaused, GetPlayerPausedTime, YSF_SetAFKAccuracy, YSF_GetAFKAccuracy, OnPlayerPauseStateChange, OnPlayerStatsAndWeaponsUpdate, OnOutcomeScmEvent.

Can't be done from Pawn, and why

ASF is a Pawn include, so it can only work with what Pawn and Pawn.RakNet can reach. These need more:

Most of the last table is possible with a C++ open.mp component (the open.mp SDK can see the scripts, the console and the RakNet server). That may come as a companion asf component later.

Differences from YSF

• Overrides stay until you reset them. SetPlayerPosForPlayer, the ...ForPlayer overrides and hidden players stay active until the matching Reset...ForPlayer / Show... call or a disconnect.
• GetPlayerPausedTime is in milliseconds (pause.inc used seconds).
• setstate in UpdatePlayerSyncData and SetPlayerSyncVehicleId is ignored: the server's real player state can't be changed from Pawn.
• SetPlayerSync* change only what is sent, not what the server's own getters return. The player's next real sync replaces them.
• Objects: HideObjectForPlayer works on global objects only (streamer objects are player objects; use streamer's per-player functions). ShowObjectForPlayer restores model, materials, position and rotation, not a MoveObject that is still running. HideNewObjectsForPlayer hides every global object created for the player while it is on, including the ones sent when they connect.
• SetExclusiveBroadcast limits RPCs only, not sync packets.
• SendRPC / SendData BS_STRING writes the characters without a length.

How it works

ASF registers Pawn.RakNet handlers for the sync packets and RPCs it needs:

• Incoming sync (on foot, driver, passenger, aim, spectating): ASF stores the last sync, tracks pause state, applies disabled keys and records the last vehicle.
• Outgoing sync: ASF drops packets of hidden players and vehicles, and rewrites positions and rotations per viewer.
• Outgoing RPCs (stream-in, name, skin, team, fighting style, objects, vehicles, pickups, scoreboard): ASF applies per-viewer overrides and blocks hidden items.

ASF hooks OnPlayerConnect, OnPlayerDisconnect, OnOutgoingRPC and RemoveBuildingForPlayer with the usual ALS chaining, so your own callbacks keep working.

Status