Basic DeusEx script explanations.
Posted: Mon Jun 19, 06 11:51 amIn this topic, I will post random scripts, basic deus ex scripts, and explain what things do, and what some variables mean.
//=============================================================================
// Sodacan.
//=============================================================================
class Sodacan extends DeusExPickup;
state Activated
{
function Activate()
{
// can't turn it off
}
function BeginState()
{
local DeusExPlayer player;
Super.BeginState();
The owner is the one who has this in his inventory. You must place DeusExPlayer() around it, to tell the script, that the owner must be a DeusExPlayer. Otherwise it will not find the function HealPlayer(), which is called further on in this script.
player = DeusExPlayer(Owner);
if (player != None)
player.HealPlayer(2, False);
It checks if the player exists, and if it does, it calls the function HealPlayer inside the player class. It has as variables 2 and False, the 2 is how much the player gets healed, and the False means that it wont give a medkit hiss, or recalculate the healing rate, when you activate it.
PlaySound(sound'MaleBurp');
This plays the oh so fun burping sound. No explanation needed?
UseOnce();
Whe you call this, the item gets deleted.
}
Begin:
}
defaultproperties
{
maxCopies=10
bCanHaveMultipleCopies=True
bActivatable=True
ItemName="Soda"
ItemArticle="some"
PlayerViewOffset=(X=30.000000,Z=-12.000000)
PlayerViewMesh=LodMesh'DeusExItems.Sodacan'
PickupViewMesh=LodMesh'DeusExItems.Sodacan'
ThirdPersonMesh=LodMesh'DeusExItems.Sodacan'
LandSound=Sound'DeusExSounds.Generic.MetalHit1'
Icon=Texture'DeusExUI.Icons.BeltIconSodaCan'
largeIcon=Texture'DeusExUI.Icons.LargeIconSodaCan'
largeIconWidth=24
largeIconHeight=45
Description="The can is blank except for the phrase 'PRODUCT PLACEMENT HERE.' It is unclear whether this is a name or an invitation."
beltDescription="SODA"
Mesh=LodMesh'DeusExItems.Sodacan'
CollisionRadius=3.000000
CollisionHeight=4.500000
Mass=5.000000
Buoyancy=3.000000
}
Now we involve the functions that get called in this script.
HealPlayer();
This can be found in DeusEx.DeusExPlayer.
// ----------------------------------------------------------------------
// HealPlayer()
// ----------------------------------------------------------------------
function int HealPlayer(int baseHealPoints, optional Bool bUseMedicineSkill)
{
As you can see, it has 2 variables in this function. The second one is optional, so you don't have to include this variable, so you can call this function on 2 ways:
HealPlayer(2);
HealPlayer(2,False/True);
local float mult;
local int adjustedHealAmount, aha2, tempaha;
local int origHealAmount;
local float dividedHealAmount;
These are variables that will be used in this function. You cannot call these variables outside the function, since it will not recognize them as declared variables. Take a good look at the word 'local'.
If you have bUseMedicineSkill = True in the function, it will recalculate the healing amount, since, if you have a high/low medkit skill, your medkit heals more/less.
if (bUseMedicineSkill)
adjustedHealAmount = CalculateSkillHealAmount(baseHealPoints);
else
adjustedHealAmount = baseHealPoints;
origHealAmount = adjustedHealAmount;
if (adjustedHealAmount > 0)
{
And if you use a medkit --> UseMedicineSkill, it will give the sound
if (bUseMedicineSkill)
PlaySound(sound'MedicalHiss', SLOT_None,,, 256);
// Heal by 3 regions via multiplayer game
if (( Level.NetMode == NM_DedicatedServer ) || ( Level.NetMode == NM_ListenServer ))
{
// DEUS_EX AMSD If legs broken, heal them a little bit first
if (HealthLegLeft == 0)
{
aha2 = adjustedHealAmount;
if (aha2 >= 5)
aha2 = 5;
tempaha = aha2;
adjustedHealAmount = adjustedHealAmount - aha2;
HealPart(HealthLegLeft, aha2);
HealPart(HealthLegRight,tempaha);
mpMsgServerFlags = mpMsgServerFlags & (~MPSERVERFLAG_LostLegs);
}
HealPart(HealthHead, adjustedHealAmount);
if ( adjustedHealAmount > 0 )
{
aha2 = adjustedHealAmount;
HealPart(HealthTorso, aha2);
aha2 = adjustedHealAmount;
HealPart(HealthArmRight,aha2);
HealPart(HealthArmLeft, adjustedHealAmount);
}
if ( adjustedHealAmount > 0 )
{
aha2 = adjustedHealAmount;
HealPart(HealthLegRight, aha2);
HealPart(HealthLegLeft, adjustedHealAmount);
}
}
else
{
HealPart(HealthHead, adjustedHealAmount);
HealPart(HealthTorso, adjustedHealAmount);
HealPart(HealthLegRight, adjustedHealAmount);
HealPart(HealthLegLeft, adjustedHealAmount);
HealPart(HealthArmRight, adjustedHealAmount);
HealPart(HealthArmLeft, adjustedHealAmount);
}
GenerateTotalHealth();
adjustedHealAmount = origHealAmount - adjustedHealAmount;
if (origHealAmount == baseHealPoints)
{
if (adjustedHealAmount == 1)
ClientMessage(Sprintf(HealedPointLabel, adjustedHealAmount));
else
ClientMessage(Sprintf(HealedPointsLabel, adjustedHealAmount));
}
else
{
ClientMessage(Sprintf(HealedPointsLabel, adjustedHealAmount));
}
}
return adjustedHealAmount;
}
I didn't explain this entire function, only parts. Otherwise this post will become too big.
The PlaySound() function, is declared in the Engine.Actor class.
native(264) final function int PlaySound
(
sound Sound,
optional ESoundSlot Slot,
optional float Volume,
optional bool bNoOverride,
optional float Radius,
optional float Pitch
);
Unfortunately, this is a native function. So that means that it is coded in Engine.dll.
You can see all variables here. It is not really important at the moment.
Now the function UseOnce();
This can be found in DeusEx.DeusExPickUp.
// ----------------------------------------------------------------------
// UseOnce()
//
// Subtract a use, then destroy if out of uses
// ----------------------------------------------------------------------
function UseOnce()
{
local DeusExPlayer player;
player = DeusExPlayer(Owner);
NumCopies--;
Reduce the number of copies you have
if (!IsA('SkilledTool'))
GotoState('DeActivated');
if (NumCopies <= 0)
{
Do you have 0 copies of the item? Or even less? Then destroy it. Also said, it will be deleted, and the item you will have in your hand, will be nothing.
if (player.inHand == Self)
player.PutInHand(None);
Destroy();
}
else
{
If you do have 1 or more copies of the item, update your belt, so you can see you used a sodacan.
UpdateBeltText();
}
}
Well, this is it kinda. I am not experienced with tutorials or whatsoever, so if something, even ANYTHING, is unclear, just ask! I will answer it
) )
):