Scripting template

[DorkeyDear]

I reorganized the template a few months ago... ill keep the old one here, but here is the one I use now:

Code: [Select]

procedure ActivateServer();
begin
end;

procedure AppOnIdle(Ticks: integer);
begin
end;

procedure OnMapChange(NewMap: string);
begin
end;

procedure OnException(ErrorMessage: string);
begin
end;

procedure OnAdminConnect(IP: string);
begin
end;

procedure OnAdminDisconnect(IP: string);
begin
end;

procedure OnAdminMessage(IP, Msg: string);
begin
end;

function OnRequestGame(IP: string; State: integer): integer;
begin
  Result := State;
end;

procedure OnJoinGame(ID, Team: byte);
begin
end;

procedure OnJoinTeam(ID, Team: byte);
begin
end;

procedure OnLeaveGame(ID, Team: byte; Kicked: boolean);
begin
end;

function OnCommand(ID: Byte; Text: string): boolean;
begin
  Result := false;
end;

function OnPlayerCommand(ID: Byte; Text: string): boolean;
begin
  Result := false;
end;

procedure OnPlayerSpeak(ID: byte; Text: string);
begin
end;

procedure OnWeaponChange(ID, PrimaryNum, SecondaryNum: byte);
begin
end;

function OnPlayerDamage(Victim, Shooter: byte; Damage: integer): integer;
begin
  Result := Damage;
end;

procedure OnPlayerKill(Killer, Victim: byte; Weapon: string);
begin
end;

procedure OnPlayerRespawn(ID: byte);
begin
end;

procedure OnFlagGrab(ID, TeamFlag: byte; GrabbedInBase: boolean);
begin
end;

procedure OnFlagReturn(ID, TeamFlag: byte);
begin
end;

procedure OnFlagScore(ID, TeamFlag: byte);
begin
end;


I just thought I would share what I use for my scripts. I like having only one file, it seems much easier to manage.

Code: [Select]

procedure OnAdminConnect(IP: string);
begin
end;

procedure OnAdminDisconnect(IP: string);
begin
end;

procedure OnAdminMessage(IP, Msg: string);
begin
end;

procedure ActivateServer();
begin
end;

procedure AppOnIdle(Ticks: integer);
begin
end;

function OnCommand(ID: Byte; Text: string): boolean;
begin
  Result := false;
end;

function OnPlayerCommand(ID: Byte; Text: string): boolean;
begin
  Result := false;
end;

procedure OnException(ErrorMessage: string);
begin
end;

function OnRequestGame(IP: string; State: integer): integer;
begin
  Result := State;
end;

procedure OnWeaponChange(ID, PrimaryNum, SecondaryNum: byte);
begin
end;

procedure OnJoinGame(ID, Team: byte);
begin
end;

procedure OnJoinTeam(ID, Team: byte);
begin
end;

procedure OnLeaveGame(ID, Team: byte; Kicked: boolean);
begin
end;

procedure OnFlagGrab(ID, TeamFlag: byte; GrabbedInBase: boolean);
begin
end;

procedure OnFlagReturn(ID, TeamFlag: byte);
begin
end;

procedure OnFlagScore(ID, TeamFlag: byte);
begin
end;

procedure OnMapChange(NewMap: string);
begin
end;

procedure OnPlayerKill(Killer, Victim: byte; Weapon: string);
begin
end;

function OnPlayerDamage(Victim, Shooter: byte; Damage: integer): integer;
begin
  Result := Damage;
end;

procedure OnPlayerRespawn(ID: byte);
begin
end;

procedure OnPlayerSpeak(ID: byte; Text: string);
begin
end;


[chrisgbk]

Stickied for great justice.

[Kavukamari]

any way you could explain all of these codes for the scripting newbies?

(me)

[DorkeyDear]

This should no longer be of much use to many people sense the change in the core to v2, which does not require every event to be in scripts.
If you read them, they should be fairly obvious. The ones that aren't so obvious are OnAdminConnect, OnAdminDisconnect, and OnAdminMessage; which relate to admins connecting from external programs (via ARSSE for example), but I can not know that for certain.
If you don't understand anything else, goto http://www.enesce.com/help for a list of these events.

[Kavukamari]

do you need to change the bytes and strings and ID's in the procedure lines for the script to work?

oh and what is a boolean? I never knew what that was

edit again: do scripts work for "novice" (not rented) dedicated servers? or will I have to rent a pro server

[Avarax]

They mustn't be changed.

[chrisgbk]

This should no longer be of much use to many people sense the change in the core to v2, which does not require every event to be in scripts.
If you read them, they should be fairly obvious. The ones that aren't so obvious are OnAdminConnect, OnAdminDisconnect, and OnAdminMessage; which relate to admins connecting from external programs (via ARSSE for example), but I can not know that for certain.
If you don't understand anything else, goto http://www.enesce.com/help for a list of these events.

I'm going to leave it stickied because it's still useful information; although if someone could check over it and make sure that it's up to date it would be appreciated. I'll do it myself later if no one gets around to it though.

[Toumaz]

I'm going to leave it stickied because it's still useful information; although if someone could check over it and make sure that it's up to date it would be appreciated.

Yes, as far as I've compared it with the latest 2.6.2 files the template seems to be up to date and current.

[JoeCool]

NEWB ALERT! how do you accually....use scripts?

[Sunshine]

with f9 in game ;]

[chrisgbk]

with f9 in game ;]

Please don't spam and spread deliberately false information, or you'll have another warning added to your existing one.

[miketh2005]

no pres F10 ingame

j/k

[FliesLikeABrick]

no pres F10 ingame

j/k

This user was warned for this post.  When a moderator posts telling someone else not to spam up this topic, it is quite stupid for you to post right after him doing the same thing.

[miketh2005]

nooooooooo don't you know what j/k means? I knew I would get warned thats why I put that, everyone knows j/k means "just kidding" meaning don't take me seriously. That's not spam its just a joke, anyway I'll take the warning since I don't disobey the rules no matter what you think of me, but you never said the duration I got warning from 1 day to 3 days to 7 days but no higher then that, no wait I might I got one for 14 days but definitly not higher then that. So whats the duration?

[spkka]

NEWB ALERT! how do you accually....use scripts?

Check this topic how  to install scripts:
http://forums.soldat.pl/index.php?topic=21468.0