Soldat Community Wiki - User contributions [en]

TOnDamageEvent

2016-07-10T10:41:42Z

Tk:

==Description==
Type used by [[TActivePlayer.OnDamage]] as an event handler type.

==Declaration==

function (Shooter, Victim: [[TActivePlayer]]; Damage: Single; BulletId: Byte): Single
Shooter: player dealing damage
Victim: player recieving damage
Damage: amount of damage (negative values heal the target)
BulletId: [[TActiveMapBullet]].ID object that dealt the damage (if it's not been a bullet, then this parameter will result in a 255, which is not a valid BulletId

[[Category:Types]]

TActivePlayer.OnDamage

2016-07-10T10:41:05Z

Tk:

'''''property OnDamage'''''
Access mode: RW
Event handler type: [[TOnDamageEvent]]
Event handler declaration: function ('''Shooter''', '''Victim''': TActivePlayer; '''Damage''': Single; '''BulletId''': Byte): Single

==Description==
Event property called when a player is hurt, whether from a killing poly, bullet or command. 

==Example==
Example ignores all damage dealt, players become invincible.
<syntaxhighlight lang="pascal">
function OnDamageZero(Shooter, Victim: TActivePlayer; Damage: Single; BulletId: Byte): Single
begin
Result := 0;
end;

var
i: Byte;
begin
for i:=1 to 32 do
Players[i].OnDamage := @OnDamageZero;
end.
</syntaxhighlight>

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer

2016-07-10T10:38:29Z

Tk:

==Inheritance==
*[[TPlayer]]
**[[TActivePlayer]]
**[[TNewPlayer]]

==Description==
Represents an active player. Accessible trough [[TPlayers.Player|Players[]]] array property.

user constructable: '''NO''' 
user destructable: '''NO'''

==Members==

{| class="wikitable"
! Member declaration !! Access mode !! Inherited !! SS Version
|-
| function [[TActivePlayer.Ban|Ban]](Time: Integer; Reason: string): Boolean || align="center" | || align="center" | no
|-
| function [[TActivePlayer.Kick|Kick]](Reason: TKickReason): Boolean || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Say|Say]](Text: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Damage|Damage]](Shooter: Byte; Damage: Integer) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.BigText|BigText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale: Single; X, Y: Integer) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.ForceWeapon|ForceWeapon]](Primary, Secondary: [[TWeapon]]) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.ForwardTo|ForwardTo]](TargetIP: string; TargetPort: Word; Message: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.GiveBonus|GiveBonus]](BType: Byte) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Move|Move]](X, Y: Single) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Tell|Tell]](Text: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.WriteConsole|WriteConsole]](Text: string; Color: Longint) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.WorldText|WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single) || || || 2.7.8.b1
|-
| procedure [[TActivePlayer.SetVelocity|SetVelocity]](VelX, VelY: Single) || || || 2.7.8.b1
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: Single || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Vest|Vest]]: Single || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Primary|Primary]]: [[TPlayerWeapon]] || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Secondary|Secondary]]: [[TPlayerWeapon]] || align="center" | R || align="center" | yes
|-
| property [[TPlayer.ShirtColor|ShirtColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.PantsColor|PantsColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.SkinColor|SkinColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.HairColor|HairColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.FavouriteWeapon|FavouriteWeapon]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChosenSecondaryWeapon|ChosenSecondaryWeapon]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Friend|Friend]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Accuracy|Accuracy]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ShootDead|ShootDead]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.GrenadeFrequency|GrenadeFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Camping|Camping]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.OnStartUse|OnStartUse]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.HairStyle|HairStyle]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Headgear|Headgear]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Chain|Chain]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.ChatFrequency|ChatFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatKill|ChatKill]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatDead|ChatDead]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatLowHealth|ChatLowHealth]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatSeeEnemy|ChatSeeEnemy]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatWinning|ChatWinning]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Dummy|Dummy]]: Boolean || align="center" | R || align="center" | yes
|-
| property [[TActivePlayer.ID|ID]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Team|Team]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TActivePlayer.Alive|Alive]]: Boolean || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TActivePlayer.Kills|Kills]]: Integer || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.Deaths|Deaths]]: Integer || align="center" | RW || align="center" | no || W since 2.8.1
|-
| property [[TActivePlayer.Ping|Ping]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Active|Active]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.IP|IP]]: string || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Port|Port]]: Word || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.VelX|VelX]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.VelY|VelY]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Muted|Muted]]: Boolean || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.Jets|Jets]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Grenades|Grenades]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.X|X]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Y|Y]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Flagger|Flagger]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Time|Time]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.OnGround|OnGround]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Human|Human]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Direction|Direction]]: Shortint || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Flags|Flags]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.HWID|HWID]]: string || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.IsAdmin|IsAdmin]]: Boolean || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.KeyUp|KeyUp]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyLeft|KeyLeft]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyRight|KeyRight]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyShoot|KeyShoot]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyJetpack|KeyJetpack]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyGrenade|KeyGrenade]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyChangeWeap|KeyChangeWeap]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyThrow|KeyThrow]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyReload|KeyReload]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyCrouch|KeyCrouch]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyProne|KeyProne]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.WeaponActive|WeaponActive]][ID: Byte]: Boolean || align="center" | W || align="center" | no
|-
| property [[TActivePlayer.OnFlagGrab|OnFlagGrab]]: [[TOnFlagGrabEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnFlagReturn|OnFlagReturn]]: [[TOnFlagReturnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnFlagScore|OnFlagScore]]: [[TOnFlagScoreEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnBeforeRespawn|OnBeforeRespawn]]: [[TOnBeforeRespawnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnAfterRespawn|OnAfterRespawn]]: [[TOnAfterRespawnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnDamage|OnDamage]]: [[TOnDamageEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnKill|OnKill]]: [[TOnKillEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnWeaponChange|OnWeaponChange]]: [[TOnWeaponChangeEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteMapStart|OnVoteMapStart]]: [[TOnVoteMapStartEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteKickStart|OnVoteKickStart]]: [[TOnVoteKickStartEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteMap|OnVoteMap]]: [[TOnVoteMapEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteKick|OnVoteKick]]: [[TOnVoteKickEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnSpeak|OnSpeak]]: [[TOnSpeakEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnCommand|OnCommand]]: [[TOnCommandEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnKitPickup|OnKitPickup]]: [[TOnKitPickupEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.OnFlagDrop|OnFlagDrop]]: [[TOnFlagDropEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|}
'''Note''': writing properties marked with "RW*" affects only bots.

[[Category:Classes]][[Category:TPlayer]]

TWeapon.WType

2016-02-23T13:42:36Z

Tk:

'''''property WType: Byte'''''
Access mode: R

==Description==
Weapon ID.
{| class="wikitable"
|-
! ID
! Weapon
|-
| 0 || Socom
|-
| 1 || Deagles
|-
| 2 || HK MP5
|-
| 3 || AK 74
|-
| 4 || Steyr
|-
| 5 || Spas
|-
| 6 || Ruger
|-
| 7 || M79
|-
| 8 || Barret
|-
| 9 || Minimi
|-
| 10 || Minigun
|-
| 11 || Knife
|-
| 12 || Chainsaw
|-
| 13 || LAW
|-
| 14 || Flamer
|-
| 15 || Bow
|-
| 16 || Flame Bow
|-
| 255 || Hands
|-
|}
 

==Constants==
Global constants representing all WTypes.
<syntaxhighlight lang="pascal">
WTYPE_EAGLE
WTYPE_MP5
WTYPE_AK74
WTYPE_STEYRAUG
WTYPE_SPAS12
WTYPE_RUGER77
WTYPE_M79
WTYPE_BARRETT
WTYPE_M249
WTYPE_MINIGUN
WTYPE_USSOCOM
WTYPE_KNIFE
WTYPE_CHAINSAW
WTYPE_LAW
WTYPE_FLAMER
WTYPE_BOW
WTYPE_BOW2
WTYPE_M2
WTYPE_NOWEAPON
WTYPE_FRAGGRENADE
WTYPE_CLUSTERGRENADE
WTYPE_CLUSTER
WTYPE_THROWNKNIFE
</syntaxhighlight>
[[Category:TWeapon]]

TActivePlayer.WeaponActive

2016-02-23T13:32:02Z

Tk:

'''''property TActivePlayer.WeaponActive[ID: Byte]: Boolean'''''
Access mode: W
==Description==
Sets a weapon available/unavailable from the weapon menu for a certain player. 
Weapon ID goes from 1 to 14 (Desert Eagles, HK .... Chainsaw, Law).

==Example==
<syntaxhighlight lang="pascal">
var i: byte;
begin
for i := 1 to 14 do
Players[ID].WeaponActive[i] := i = 12; // deactivate all weapons but knife
</syntaxhighlight>

[[Category:TActivePlayer]]

TMapObject.Style

2016-01-22T16:01:03Z

Tk:

'''''property Style: Integer'''''
Access mode: R

==Description==
Number representing MapObject's style.
{| class="wikitable"
! '''Style''' || '''Description'''
|-
| 1 || Alpha Flag
|-
| 2 || Bravo Flag
|-
| 3 || Point Match Flag
|-
| 4 || USSOCOM
|-
| 5 || Desert Eagle
|-
| 6 || HK MP5
|-
| 7 || AK 74
|-
| 8 || Steyr AUG
|-
| 9 || Spas 12
|-
| 10 || Ruger77
|-
| 11 || M79
|-
| 12 || Barrett M82A1
|-
| 13 || Minimi
|-
| 14 || Minigun
|-
| 15 || Rambo Bow
|-
| 16 || Medical Kit
|-
| 17 || Grenade Kit
|-
| 18 || Flamer Kit
|-
| 19 || Predator Kit
|-
| 20 || Vest Kit
|-
| 21 || Beserk Kit
|-
| 22 || Cluster Kit
|-
| 23 || Parachute
|-
| 24 || Combat Knife
|-
| 25 || Chainsaw
|-
| 26 || LAW
|-
| 27 || Stationary Gun
|-
|}

==Constants==
Global constants with object types.
<syntaxhighlight lang="pascal">
OBJECT_ALPHA_FLAG
OBJECT_BRAVO_FLAG
OBJECT_POINTMATCH_FLAG
OBJECT_USSOCOM
OBJECT_DESERT_EAGLE
OBJECT_HK_MP5
OBJECT_AK74
OBJECT_STEYR_AUG
OBJECT_SPAS12
OBJECT_RUGER77
OBJECT_M79
OBJECT_BARRET_M82A1
OBJECT_MINIMI
OBJECT_MINIGUN
OBJECT_RAMBO_BOW
OBJECT_MEDICAL_KIT
OBJECT_GRENADE_KIT
OBJECT_FLAMER_KIT
OBJECT_PREDATOR_KIT
OBJECT_VEST_KIT
OBJECT_BERSERK_KIT
OBJECT_CLUSTER_KIT
OBJECT_PARACHUTE
OBJECT_COMBAT_KNIFE
OBJECT_CHAINSAW
OBJECT_LAW
OBJECT_STATIONARY_GUN
</syntaxhighlight>

[[Category:TMapObject]]

TMap.AddObject

2016-01-22T16:00:34Z

Tk:

'''function AddObject(Obj: [[TNewMapObject]]):[[TActiveMapObject]]'''
Obj: new object to be placed on the map
Result: newly created object 

==Description==

This function will add a new object at position X,Y with target style. It will always be active.

==Example==
The below example will spawn a medkit on the players position whenever he types "Medic!"

<syntaxhighlight lang="pascal">
var
i: integer;

procedure SpawnMedkit(posx,posy: single);
var temp: TNewMapObject;
begin
temp := TNewMapObject.Create;
temp.X := posx;
temp.Y := posy;
temp.Style := 16; // medkit
Map.AddObject(temp);
temp.Free; // IMPORTANT!
end;

procedure MyOnSpeak(p: TActivePlayer; Text: string);
begin
if Text = 'Medic!' then
SpawnMedkit(p.X,p.Y);z
end;

begin
for i:=1 to 32 do
Players[i].OnSpeak := @MyOnSpeak;
end.
</syntaxhighlight>

==Constants==
Global constants with object types.
<syntaxhighlight lang="pascal">
OBJECT_ALPHA_FLAG
OBJECT_BRAVO_FLAG
OBJECT_POINTMATCH_FLAG
OBJECT_USSOCOM
OBJECT_DESERT_EAGLE
OBJECT_HK_MP5
OBJECT_AK74
OBJECT_STEYR_AUG
OBJECT_SPAS12
OBJECT_RUGER77
OBJECT_M79
OBJECT_BARRET_M82A1
OBJECT_MINIMI
OBJECT_MINIGUN
OBJECT_RAMBO_BOW
OBJECT_MEDICAL_KIT
OBJECT_GRENADE_KIT
OBJECT_FLAMER_KIT
OBJECT_PREDATOR_KIT
OBJECT_VEST_KIT
OBJECT_BERSERK_KIT
OBJECT_CLUSTER_KIT
OBJECT_PARACHUTE
OBJECT_COMBAT_KNIFE
OBJECT_CHAINSAW
OBJECT_LAW
OBJECT_STATIONARY_GUN
</syntaxhighlight>

[[Category:TMap]]