Unreal Wiki - User contributions [en]

UE1:SkaarjTrooper (UT)

2017-07-17T14:35:16Z

SeriousBarbie: -" "

{{infobox class
| package = UnrealI
| parent1 = Skaarj
| parent2 = ScriptedPawn
| parent3 = Pawn
| parent4 = Actor
| parent5 = Object
}}
{{autogenerated}}
SkaarjTrooper.

==Properties==
===Property group 'SkaarjTrooper'===
====WeaponType====
'''Type:''' [[class]]<{{cl|Weapon}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|DispersionPistol|UnrealShare}}'

===Internal variables===
====duckTime====
'''Type:''' [[float]]



====myWeapon====
'''Type:''' {{cl|Weapon}}



===Default values===
{| class="list defaults"
! Property
! Value
|-
| {{tl|Buoyancy||Actor properties}}
| 125.0
|-
| {{tl|CarcassType||ScriptedPawn properties}}
| [[Types#Class|Class]]'{{cl|TrooperCarcass|UnrealI}}'
|-
| {{tl|ClawDamage||Skaarj}}
| 10
|-
| {{tl|CollisionHeight||Actor properties}}
| 42.0
|-
| {{tl|CollisionRadius||Actor properties}}
| 32.0
|-
| {{tl|CombatStyle||Pawn}}
| 0.3
|-
| {{tl|GroundSpeed||Pawn}}
| 400.0
|-
| {{tl|Health||Pawn}}
| 170
|-
| {{tl|LungeDamage||Skaarj}}
| 20
|-
| {{tl|Mass||Actor properties}}
| 125.0
|-
| {{tl|Mesh||Actor properties}}
| {{cl|LodMesh}}'UnrealI.sktrooper'
|-
| {{tl|RangedProjectile||ScriptedPawn properties}}
| None
|-
| {{tl|Skin||Actor properties}}
| {{cl|Texture}}'UnrealI.Skins.sktrooper1'
|-
| {{tl|SpinDamage||Skaarj}}
| 15
|}

==Functions==
===Events===
====PreBeginPlay====
{{code|event '''PreBeginPlay''' ()}}

'''Overrides:''' {{tl|PreBeginPlay|Skaarj}}



===Other instance functions===
====CanFireAtEnemy====
{{code|function [[bool]] '''CanFireAtEnemy''' ()}}

'''Overrides:''' {{tl|CanFireAtEnemy|ScriptedPawn|instance functions}}



====ChangedWeapon====
{{code|function '''ChangedWeapon''' ()}}

'''Overrides:''' {{tl|ChangedWeapon|Pawn|instance functions}}



====Died====
{{code|function '''Died''' ({{cl|Pawn}} '''Killer''', [[name]] '''damageType''', {{tl|Vector|Object|structs}} '''HitLocation''')}}

'''Overrides:''' {{tl|Died|Pawn|instance functions}}



====PlayChallenge====
{{code|function '''PlayChallenge''' ()}}

'''Overrides:''' {{tl|PlayChallenge|ScriptedPawn|instance functions}}



====PlayCock====
{{code|function '''PlayCock''' ()}}

'''Overrides:''' {{tl|PlayCock|Skaarj|instance functions}}

If SkaarjTrooper's weapon and ''Weapon.CockingSound'' is given, that sound is played on ''SLOT_Interact''.

Probably a bug is playing ''Weapon.CockingSound'', if it is empty but ''Weapon.SelectSound'' is given:
<pre>if ( Weapon.CockingSound != None )
PlaySound(Weapon.CockingSound, SLOT_Interact,,,700);
else if ( Weapon.SelectSound != None )
PlaySound(Weapon.CockingSound, SLOT_Interact,,,700);</pre>

====PlayFiring====
{{code|function '''PlayFiring''' ()}}

'''Overrides:''' {{tl|PlayFiring|ScriptedPawn|instance functions}}



====PlayLanded====
{{code|function '''PlayLanded''' ([[float]] '''impactVel''')}}

'''Overrides:''' {{tl|PlayLanded|Skaarj|instance functions}}



====PlayMovingAttack====
{{code|function '''PlayMovingAttack''' ()}}

'''Overrides:''' {{tl|PlayMovingAttack|Pawn|instance functions}}



====PlayPatrolStop====
{{code|function '''PlayPatrolStop''' ()}}

'''Overrides:''' {{tl|PlayPatrolStop|Pawn|instance functions}}



====PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|PlayRangedAttack|Skaarj|instance functions}}



====PlayRunning====
{{code|function '''PlayRunning''' ()}}

'''Overrides:''' {{tl|PlayRunning|Pawn|instance functions}}



====PlayTakeHit====
{{code|function '''PlayTakeHit''' ([[float]] '''tweentime''', {{tl|Vector|Object|structs}} '''HitLoc''', [[int]] '''damage''')}}

'''Overrides:''' {{tl|PlayTakeHit|Skaarj|instance functions}}



====PlayThreatening====
{{code|function '''PlayThreatening''' ()}}

'''Overrides:''' {{tl|PlayThreatening|Pawn|instance functions}}



====PlayVictoryDance====
{{code|function '''PlayVictoryDance''' ()}}

'''Overrides:''' {{tl|PlayVictoryDance|Pawn|instance functions}}



====Shield====
{{code|function '''Shield''' ()}}



====TossWeapon====
{{code|function '''TossWeapon''' ()}}

'''Overrides:''' {{tl|TossWeapon|Pawn|instance functions}}



====TryToDuck====
{{code|function '''TryToDuck''' ({{tl|Vector|Object|structs}} '''duckDir''', [[bool]] '''bReversed''')}}

'''Overrides:''' {{tl|TryToDuck|ScriptedPawn|instance functions}}



====WarnTarget====
{{code|function '''WarnTarget''' ({{cl|Pawn}} '''shooter''', [[float]] '''projSpeed''', {{tl|Vector|Object|structs}} '''FireDir''')}}

'''Overrides:''' {{tl|WarnTarget|ScriptedPawn|instance functions}}



==States==
===Charging===


'''Inherits from:''' {{tl|Charging|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====Charging.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|Charging.EndState|ScriptedPawn}}



===Hunting===


'''Inherits from:''' {{tl|Hunting|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|EnemyNotVisible||Pawn}}

====Hunting.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|Hunting.EndState|Skaarj}}



===MeleeAttack===


'''Inherits from:''' {{tl|MeleeAttack|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|Bump||ScriptedPawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

===RangedAttack===


'''Inherits from:''' {{tl|RangedAttack|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====RangedAttack.AnimEnd====
{{code|event '''AnimEnd''' ()}}

'''Overrides:''' {{tl|RangedAttack.AnimEnd|ScriptedPawn}}



====RangedAttack.Bump====
{{code|event '''Bump''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|RangedAttack.Bump|Skaarj}}



====RangedAttack.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|RangedAttack.EndState|ScriptedPawn}}



====RangedAttack.TakeDamage====
{{code|event '''TakeDamage''' ([[int]] '''Damage''', {{cl|Pawn}} '''instigatedBy''', {{tl|Vector|Object|structs}} '''hitlocation''', {{tl|Vector|Object|structs}} '''momentum''', [[name]] '''damageType''')}}

'''Overrides:''' {{tl|RangedAttack.TakeDamage|ScriptedPawn}}



====RangedAttack.KeepAttacking====
{{code|function '''KeepAttacking''' ()}}

'''Overrides:''' {{tl|RangedAttack.KeepAttacking|ScriptedPawn}}



====RangedAttack.PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|RangedAttack.PlayRangedAttack|Skaarj}}



====RangedAttack.TryToDuck====
{{code|function '''TryToDuck''' ({{tl|Vector|Object|structs}} '''duckDir''', [[bool]] '''bReversed''')}}

'''Overrides:''' {{tl|TryToDuck}} ''(global)''



===Retreating===


'''Inherits from:''' {{tl|Retreating|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|EnemyNotVisible||Pawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====Retreating.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|EndState|Object}} ''(global)''



===Startup===


'''Inherits from:''' {{tl|StartUp|ScriptedPawn}}

'''[[States#Modifiers|Modifiers]]:''' auto

====Startup.BeginState====
{{code|event '''BeginState''' ()}}

'''Overrides:''' {{tl|StartUp.BeginState|ScriptedPawn}}



====Startup.SetHome====
{{code|function '''SetHome''' ()}}

'''Overrides:''' {{tl|StartUp.SetHome|ScriptedPawn}}



===TacticalMove===


'''Inherits from:''' {{tl|TacticalMove|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====TacticalMove.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|TacticalMove.EndState|ScriptedPawn}}



===TakeHit===


'''Inherits from:''' {{tl|TakeHit|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|Bump||ScriptedPawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|HitWall||Actor events}}, {{tl|SeePlayer||ScriptedPawn}}

====TakeHit.BeginState====
{{code|event '''BeginState''' ()}}

'''Overrides:''' {{tl|TakeHit.BeginState|Skaarj}}

UE1:Skaarj instance functions (UT)

2017-07-17T01:14:15Z

SeriousBarbie: PlayCock: description

{{infobox class part
| class = Skaarj
| part = instance functions
| parent1 = ScriptedPawn
| parent2 = Pawn
| parent3 = Actor
| parent4 = Object
}}
{{autogenerated}}
==Instance functions==
====AttitudeToCreature====
{{code|function {{tl|EAttitude|Pawn}} '''AttitudeToCreature''' ({{cl|Pawn}} '''Other''')}}

'''Overrides:''' {{tl|AttitudeToCreature|ScriptedPawn|instance functions}}



====ClawDamageTarget====
{{code|function '''ClawDamageTarget''' ()}}



====PlayAcquisitionSound====
{{code|function '''PlayAcquisitionSound''' ()}}

'''Overrides:''' {{tl|PlayAcquisitionSound|ScriptedPawn|instance functions}}



====PlayBigDeath====
{{code|function '''PlayBigDeath''' ([[name]] '''DamageType''')}}

'''Overrides:''' {{tl|PlayBigDeath|Pawn|instance functions}}



====PlayCock====
{{code|function '''PlayCock''' ()}}

Empty function in this abstract class; may be overridden in child classes.

====PlayDive====
{{code|function '''PlayDive''' ()}}

'''Overrides:''' {{tl|PlayDive|Pawn|instance functions}}



====PlayFearSound====
{{code|function '''PlayFearSound''' ()}}

'''Overrides:''' {{tl|PlayFearSound|ScriptedPawn|instance functions}}



====PlayGutDeath====
{{code|function '''PlayGutDeath''' ([[name]] '''DamageType''')}}

'''Overrides:''' {{tl|PlayGutDeath|Pawn|instance functions}}



====PlayHeadDeath====
{{code|function '''PlayHeadDeath''' ([[name]] '''DamageType''')}}

'''Overrides:''' {{tl|PlayHeadDeath|Pawn|instance functions}}



====PlayInAir====
{{code|function '''PlayInAir''' ()}}

'''Overrides:''' {{tl|PlayInAir|Pawn|instance functions}}



====PlayLanded====
{{code|function '''PlayLanded''' ([[float]] '''impactVel''')}}

'''Overrides:''' {{tl|PlayLanded|Pawn|instance functions}}



====PlayLeftDeath====
{{code|function '''PlayLeftDeath''' ([[name]] '''DamageType''')}}

'''Overrides:''' {{tl|PlayLeftDeath|Pawn|instance functions}}



====PlayMeleeAttack====
{{code|function '''PlayMeleeAttack''' ()}}

'''Overrides:''' {{tl|PlayMeleeAttack|ScriptedPawn|instance functions}}



====PlayOutOfWater====
{{code|function '''PlayOutOfWater''' ()}}

'''Overrides:''' {{tl|PlayOutOfWater|Pawn|instance functions}}



====PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|PlayRangedAttack|ScriptedPawn|instance functions}}



====PlayRightDeath====
{{code|function '''PlayRightDeath''' ([[name]] '''DamageType''')}}

'''Overrides:''' {{tl|PlayRightDeath|Pawn|instance functions}}



====PlayRoamingSound====
{{code|function '''PlayRoamingSound''' ()}}

'''Overrides:''' {{tl|PlayRoamingSound|ScriptedPawn|instance functions}}



====PlaySwimming====
{{code|function '''PlaySwimming''' ()}}



====PlayTakeHit====
{{code|function '''PlayTakeHit''' ([[float]] '''tweentime''', {{tl|Vector|Object|structs}} '''HitLoc''', [[int]] '''damage''')}}

'''Overrides:''' {{tl|PlayTakeHit|Pawn|instance functions}}



====PlayTakeHitSound====
{{code|function '''PlayTakeHitSound''' ([[int]] '''Damage''', [[name]] '''damageType''', [[int]] '''Mult''')}}

'''Overrides:''' {{tl|PlayTakeHitSound|Pawn|instance functions}}



====PlayThreateningSound====
{{code|function '''PlayThreateningSound''' ()}}

'''Overrides:''' {{tl|PlayThreateningSound|ScriptedPawn|instance functions}}



====PlayTurning====
{{code|function '''PlayTurning''' ()}}

'''Overrides:''' {{tl|PlayTurning|Pawn|instance functions}}



====PlayWaiting====
{{code|function '''PlayWaiting''' ()}}

'''Overrides:''' {{tl|PlayWaiting|Pawn|instance functions}}



====PlayWaitingAmbush====
{{code|function '''PlayWaitingAmbush''' ()}}

'''Overrides:''' {{tl|PlayWaitingAmbush|Pawn|instance functions}}



====PlayWalking====
{{code|function '''PlayWalking''' ()}}

'''Overrides:''' {{tl|PlayWalking|Pawn|instance functions}}



====PreSetMovement====
{{code|function '''PreSetMovement''' ()}}

'''Overrides:''' {{tl|PreSetMovement|Pawn|instance functions}}



====PushButtons====
{{code|function '''PushButtons''' ()}}



====RunStep====
{{code|function '''RunStep''' ()}}



====SetMovementPhysics====
{{code|function '''SetMovementPhysics''' ()}}

'''Overrides:''' {{tl|SetMovementPhysics|ScriptedPawn|instance functions}}



====Speak====
{{code|function '''Speak''' ()}}

'''Overrides:''' {{tl|Speak|ScriptedPawn|instance functions}}



====SpeakOrderTo====
{{code|function '''SpeakOrderTo''' ({{cl|ScriptedPawn}} '''TeamMember''')}}

'''Overrides:''' {{tl|SpeakOrderTo|ScriptedPawn|instance functions}}



====SpeakTo====
{{code|function '''SpeakTo''' ({{cl|ScriptedPawn}} '''Other''')}}

'''Overrides:''' {{tl|SpeakTo|ScriptedPawn|instance functions}}



====SpinDamageTarget====
{{code|function '''SpinDamageTarget''' ()}}



====TweenToFalling====
{{code|function '''TweenToFalling''' ()}}

'''Overrides:''' {{tl|TweenToFalling|Pawn|instance functions}}



====TweenToFighter====
{{code|function '''TweenToFighter''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToFighter|Pawn|instance functions}}



====TweenToPatrolStop====
{{code|function '''TweenToPatrolStop''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToPatrolStop|Pawn|instance functions}}



====TweenToRunning====
{{code|function '''TweenToRunning''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToRunning|Pawn|instance functions}}



====TweenToSwimming====
{{code|function '''TweenToSwimming''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToSwimming|Pawn|instance functions}}



====TweenToWaiting====
{{code|function '''TweenToWaiting''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToWaiting|Pawn|instance functions}}



====TweenToWalking====
{{code|function '''TweenToWalking''' ([[float]] '''tweentime''')}}

'''Overrides:''' {{tl|TweenToWalking|Pawn|instance functions}}



====WalkStep====
{{code|function '''WalkStep''' ()}}

UE1:SkaarjTrooper (UT)

2017-07-17T01:11:22Z

SeriousBarbie: PlayCock: description

{{infobox class
| package = UnrealI
| parent1 = Skaarj
| parent2 = ScriptedPawn
| parent3 = Pawn
| parent4 = Actor
| parent5 = Object
}}
{{autogenerated}}
SkaarjTrooper.

==Properties==
===Property group 'SkaarjTrooper'===
====WeaponType====
'''Type:''' [[class]]<{{cl|Weapon}}>



'''Default value:''' [[Types#Class|Class]]'{{cl|DispersionPistol|UnrealShare}}'

===Internal variables===
====duckTime====
'''Type:''' [[float]]



====myWeapon====
'''Type:''' {{cl|Weapon}}



===Default values===
{| class="list defaults"
! Property
! Value
|-
| {{tl|Buoyancy||Actor properties}}
| 125.0
|-
| {{tl|CarcassType||ScriptedPawn properties}}
| [[Types#Class|Class]]'{{cl|TrooperCarcass|UnrealI}}'
|-
| {{tl|ClawDamage||Skaarj}}
| 10
|-
| {{tl|CollisionHeight||Actor properties}}
| 42.0
|-
| {{tl|CollisionRadius||Actor properties}}
| 32.0
|-
| {{tl|CombatStyle||Pawn}}
| 0.3
|-
| {{tl|GroundSpeed||Pawn}}
| 400.0
|-
| {{tl|Health||Pawn}}
| 170
|-
| {{tl|LungeDamage||Skaarj}}
| 20
|-
| {{tl|Mass||Actor properties}}
| 125.0
|-
| {{tl|Mesh||Actor properties}}
| {{cl|LodMesh}}'UnrealI.sktrooper'
|-
| {{tl|RangedProjectile||ScriptedPawn properties}}
| None
|-
| {{tl|Skin||Actor properties}}
| {{cl|Texture}}'UnrealI.Skins.sktrooper1'
|-
| {{tl|SpinDamage||Skaarj}}
| 15
|}

==Functions==
===Events===
====PreBeginPlay====
{{code|event '''PreBeginPlay''' ()}}

'''Overrides:''' {{tl|PreBeginPlay|Skaarj}}



===Other instance functions===
====CanFireAtEnemy====
{{code|function [[bool]] '''CanFireAtEnemy''' ()}}

'''Overrides:''' {{tl|CanFireAtEnemy|ScriptedPawn|instance functions}}



====ChangedWeapon====
{{code|function '''ChangedWeapon''' ()}}

'''Overrides:''' {{tl|ChangedWeapon|Pawn|instance functions}}



====Died====
{{code|function '''Died''' ({{cl|Pawn}} '''Killer''', [[name]] '''damageType''', {{tl|Vector|Object|structs}} '''HitLocation''')}}

'''Overrides:''' {{tl|Died|Pawn|instance functions}}



====PlayChallenge====
{{code|function '''PlayChallenge''' ()}}

'''Overrides:''' {{tl|PlayChallenge|ScriptedPawn|instance functions}}



====PlayCock====
{{code|function '''PlayCock''' ()}}

'''Overrides:''' {{tl|PlayCock|Skaarj|instance functions}}

If SkaarjTrooper's weapon and ''Weapon.CockingSound'' is given, that sound is played on ''SLOT_Interact''.

Probably a bug is playing ''Weapon.CockingSound'', if it is empty but ''Weapon.SelectSound'' is given:
<pre>if ( Weapon.CockingSound != None )
PlaySound(Weapon.CockingSound, SLOT_Interact,,,700);
else if ( Weapon.SelectSound != None ) 
PlaySound(Weapon.CockingSound, SLOT_Interact,,,700);</pre>

====PlayFiring====
{{code|function '''PlayFiring''' ()}}

'''Overrides:''' {{tl|PlayFiring|ScriptedPawn|instance functions}}



====PlayLanded====
{{code|function '''PlayLanded''' ([[float]] '''impactVel''')}}

'''Overrides:''' {{tl|PlayLanded|Skaarj|instance functions}}



====PlayMovingAttack====
{{code|function '''PlayMovingAttack''' ()}}

'''Overrides:''' {{tl|PlayMovingAttack|Pawn|instance functions}}



====PlayPatrolStop====
{{code|function '''PlayPatrolStop''' ()}}

'''Overrides:''' {{tl|PlayPatrolStop|Pawn|instance functions}}



====PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|PlayRangedAttack|Skaarj|instance functions}}



====PlayRunning====
{{code|function '''PlayRunning''' ()}}

'''Overrides:''' {{tl|PlayRunning|Pawn|instance functions}}



====PlayTakeHit====
{{code|function '''PlayTakeHit''' ([[float]] '''tweentime''', {{tl|Vector|Object|structs}} '''HitLoc''', [[int]] '''damage''')}}

'''Overrides:''' {{tl|PlayTakeHit|Skaarj|instance functions}}



====PlayThreatening====
{{code|function '''PlayThreatening''' ()}}

'''Overrides:''' {{tl|PlayThreatening|Pawn|instance functions}}



====PlayVictoryDance====
{{code|function '''PlayVictoryDance''' ()}}

'''Overrides:''' {{tl|PlayVictoryDance|Pawn|instance functions}}



====Shield====
{{code|function '''Shield''' ()}}



====TossWeapon====
{{code|function '''TossWeapon''' ()}}

'''Overrides:''' {{tl|TossWeapon|Pawn|instance functions}}



====TryToDuck====
{{code|function '''TryToDuck''' ({{tl|Vector|Object|structs}} '''duckDir''', [[bool]] '''bReversed''')}}

'''Overrides:''' {{tl|TryToDuck|ScriptedPawn|instance functions}}



====WarnTarget====
{{code|function '''WarnTarget''' ({{cl|Pawn}} '''shooter''', [[float]] '''projSpeed''', {{tl|Vector|Object|structs}} '''FireDir''')}}

'''Overrides:''' {{tl|WarnTarget|ScriptedPawn|instance functions}}



==States==
===Charging===


'''Inherits from:''' {{tl|Charging|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====Charging.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|Charging.EndState|ScriptedPawn}}



===Hunting===


'''Inherits from:''' {{tl|Hunting|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|EnemyNotVisible||Pawn}}

====Hunting.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|Hunting.EndState|Skaarj}}



===MeleeAttack===


'''Inherits from:''' {{tl|MeleeAttack|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|Bump||ScriptedPawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

===RangedAttack===


'''Inherits from:''' {{tl|RangedAttack|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====RangedAttack.AnimEnd====
{{code|event '''AnimEnd''' ()}}

'''Overrides:''' {{tl|RangedAttack.AnimEnd|ScriptedPawn}}



====RangedAttack.Bump====
{{code|event '''Bump''' ({{cl|Actor}} '''Other''')}}

'''Overrides:''' {{tl|RangedAttack.Bump|Skaarj}}



====RangedAttack.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|RangedAttack.EndState|ScriptedPawn}}



====RangedAttack.TakeDamage====
{{code|event '''TakeDamage''' ([[int]] '''Damage''', {{cl|Pawn}} '''instigatedBy''', {{tl|Vector|Object|structs}} '''hitlocation''', {{tl|Vector|Object|structs}} '''momentum''', [[name]] '''damageType''')}}

'''Overrides:''' {{tl|RangedAttack.TakeDamage|ScriptedPawn}}



====RangedAttack.KeepAttacking====
{{code|function '''KeepAttacking''' ()}}

'''Overrides:''' {{tl|RangedAttack.KeepAttacking|ScriptedPawn}}



====RangedAttack.PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|RangedAttack.PlayRangedAttack|Skaarj}}



====RangedAttack.TryToDuck====
{{code|function '''TryToDuck''' ({{tl|Vector|Object|structs}} '''duckDir''', [[bool]] '''bReversed''')}}

'''Overrides:''' {{tl|TryToDuck}} ''(global)''



===Retreating===


'''Inherits from:''' {{tl|Retreating|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|EnemyNotVisible||Pawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====Retreating.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|EndState|Object}} ''(global)''



===Startup===


'''Inherits from:''' {{tl|StartUp|ScriptedPawn}}

'''[[States#Modifiers|Modifiers]]:''' auto

====Startup.BeginState====
{{code|event '''BeginState''' ()}}

'''Overrides:''' {{tl|StartUp.BeginState|ScriptedPawn}}



====Startup.SetHome====
{{code|function '''SetHome''' ()}}

'''Overrides:''' {{tl|StartUp.SetHome|ScriptedPawn}}



===TacticalMove===


'''Inherits from:''' {{tl|TacticalMove|ScriptedPawn}}

'''[[Ignores statement|Ignores]]:''' {{tl|HearNoise||ScriptedPawn}}, {{tl|SeePlayer||ScriptedPawn}}

====TacticalMove.EndState====
{{code|event '''EndState''' ()}}

'''Overrides:''' {{tl|TacticalMove.EndState|ScriptedPawn}}



===TakeHit===


'''Inherits from:''' {{tl|TakeHit|Skaarj}}

'''[[Ignores statement|Ignores]]:''' {{tl|Bump||ScriptedPawn}}, {{tl|HearNoise||ScriptedPawn}}, {{tl|HitWall||Actor events}}, {{tl|SeePlayer||ScriptedPawn}}

====TakeHit.BeginState====
{{code|event '''BeginState''' ()}}

'''Overrides:''' {{tl|TakeHit.BeginState|Skaarj}}

UE1:SkaarjWarrior (UT)

2017-07-17T01:03:01Z

SeriousBarbie: PlayCock: description

{{infobox class
| package = UnrealShare
| parent1 = Skaarj
| parent2 = ScriptedPawn
| parent3 = Pawn
| parent4 = Actor
| parent5 = Object
}}
{{autogenerated}}
Skaarj.

==Properties==
===Property group 'Sounds'===
====Blade====
'''Type:''' {{cl|Sound}}



'''Default value:''' {{cl|Sound}}'UnrealShare.Skaarj.blade1s'

===Default values===
{| class="list defaults"
! Property
! Value
|-
| {{tl|ClawDamage||Skaarj}}
| 14
|-
| {{tl|CombatStyle||Pawn}}
| 0.6
|-
| {{tl|Mesh||Actor properties}}
| {{cl|LodMesh}}'UnrealShare.Skaarjw'
|-
| {{tl|SpinDamage||Skaarj}}
| 16
|}

==Functions==
===Events===
====PostBeginPlay====
{{code|event '''PostBeginPlay''' ()}}

'''Overrides:''' {{tl|PostBeginPlay|Pawn}}



===Other instance functions===
====CanFireAtEnemy====
{{code|function [[bool]] '''CanFireAtEnemy''' ()}}

'''Overrides:''' {{tl|CanFireAtEnemy|ScriptedPawn|instance functions}}



====PlayChallenge====
{{code|function '''PlayChallenge''' ()}}

'''Overrides:''' {{tl|PlayChallenge|ScriptedPawn|instance functions}}



====PlayCock====
{{code|function '''PlayCock''' ()}}

'''Overrides:''' {{tl|PlayCock|Skaarj|instance functions}}

Plays the sound given in 'Blade' on ''SLOT_Interact''.

====PlayMovingAttack====
{{code|function '''PlayMovingAttack''' ()}}

'''Overrides:''' {{tl|PlayMovingAttack|Pawn|instance functions}}



====PlayPatrolStop====
{{code|function '''PlayPatrolStop''' ()}}

'''Overrides:''' {{tl|PlayPatrolStop|Pawn|instance functions}}



====PlayRangedAttack====
{{code|function '''PlayRangedAttack''' ()}}

'''Overrides:''' {{tl|PlayRangedAttack|Skaarj|instance functions}}



====PlayRunning====
{{code|function '''PlayRunning''' ()}}

'''Overrides:''' {{tl|PlayRunning|Pawn|instance functions}}



====PlayThreatening====
{{code|function '''PlayThreatening''' ()}}

'''Overrides:''' {{tl|PlayThreatening|Pawn|instance functions}}



====PlayVictoryDance====
{{code|function '''PlayVictoryDance''' ()}}

'''Overrides:''' {{tl|PlayVictoryDance|Pawn|instance functions}}



====SpawnTwoShots====
{{code|function '''SpawnTwoShots''' ()}}



====TryToDuck====
{{code|function '''TryToDuck''' ({{tl|Vector|Object|structs}} '''duckDir''', [[bool]] '''bReversed''')}}

'''Overrides:''' {{tl|TryToDuck|ScriptedPawn|instance functions}}

Legacy:Actor (UT)/Advanced

2017-04-09T05:22:43Z

SeriousBarbie: +link to game_goals

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Object (UT)|Object (UT)]] >> [[Legacy:Actor (UT)|Actor (UT)]] (Property group: Advanced)}}

Properties every [[Legacy:Actor (UT)|Actor (UT)]] has under the ''Advanced'' section. See [[Legacy:Actor/Advanced|Actor/Advanced]] for the [[Legacy:UT2003|UT2003]] version.

; bAlwaysRelevant : [[Legacy:Replication|Replication]] – If set, then this actor is always relevant to gameplay. As a result, the server will always be keeping tabs on this actor and constantly sending data to its clients about it, regardless of any other circumstances. For example, [[Legacy:ReplicationInfo|ReplicationInfo]]s are always relevant.

; bCanTeleport : If something attempts to teleport the actor, then the attempt will be successful. For example, this is ''True'' for [[Legacy:Pawn (UT)|Pawn (UT)]]s and ''False'' for [[Legacy:Inventory (UT)|Inventory (UT)]] items.

; bCollideWhenPlacing : When being placed using the editor, this actor will not allow itself to be moved through walls and other such things.

; bDirectional : An actor which has this flag set will display a directional arrow in UnrealEd when selected. This directional arrow matches the current setting of the actor's Movement -> Rotation property (see [[Legacy:Actor (UT)/Movement|Actor (UT)/Movement]]). It also allows the actor to be rotated the same way as a brush in an [[Legacy:UnrealEd Viewport|UnrealEd Viewport]] (see [[Legacy:Brush Rotate|Brush rotate]]). By default, [[Legacy:Spotlight|Spotlight]]s, [[Legacy:PlayerStart|PlayerStart]]s and some [[Legacy:Decoration|Decoration]]s are directional, but [[Legacy:Trigger|Trigger]]s and ordinary [[Legacy:Light (UT)|Light (UT)]]s are not. '''Tip:''' Set this to ''True'' for brushes (including the [[Legacy:Red Builder Brush|red builder brush]]) to see whether they have rotation applied.

; bEdShouldSnap : In the editor, this actor should snap to the grid when it is being placed. This is set by default to ''True'' for [[Legacy:Brush|Brush]]es and ''False'' for other actors. It's often useful to set this to ''True'' for actors such as [[Legacy:Trigger|Trigger]] or [[Legacy:BlockAll|BlockAll]], as they can then be aligned to the grid exactly. The value of this property determines whether an actor has a [[Legacy:Pivot|pivot]].

; bForceStasis : In stand-alone games, this actor can be forced into stasis when it doesn't need to be updated, even if it has physics is something more meaningful than simple rotation.

; bGameRelevant : This actor is relevant to gameplay. For example, this is ''True'' for such things as [[Legacy:GameInfo (UT)|GameInfo (UT)]] and [[Legacy:ReplicationInfo|ReplicationInfo]]. If this is set to True mutators won't change or replace the actor.

; bHidden : During the game, this actor should not be displayed. Obviously, things like [[Legacy:Pawn (UT)|Pawn (UT)]]s are not hidden, but [[Legacy:Triggers (UT)|Triggers (UT)]] are.

; bHiddenEd : In the editor, this actor should not be displayed. It's for instance used for the [[Legacy:LevelInfo|LevelInfo]] actor that is automatically added when you create a new map. (The [[Legacy:LevelInfo|LevelInfo]] actor's properties can be set with [[Legacy:UnrealEd Main Menu|UnrealEd Main Menu]] -> View -> Level Properties) Some mappers set this flag on the brushes in their levels. To reveal a brush that has been hidden like this, first find it in the [[Legacy:Actor Search|Actor Search]] window. Double-clicking its name there will selected it even though it isn't visible in any [[Legacy:UnrealEd Viewport|UnrealEd Viewport]]. Then open the [[Legacy:Actor Properties Window|Actor Properties window]] (F4) and set this flag to ''False''. The object in question should re-appear.

; bHighDetail : This actor will only show up if the game is set to render high detail. This is typically used with [[Legacy:SkyZoneInfo|SkyZoneInfo]] objects to provide two [[Legacy:SkyBox|SkyBox]]es. One used when high detail is set, and the other used when high detail is not set.

; bIsItemGoal : This actor will count in the item count of some such mechanic. [[Legacy:Inventory (UT)|Inventory (UT)]] items are examples of this.

; bIsKillGoal : This actor will count in the death tally. [[Legacy:ScriptedPawn|ScriptedPawn]]s are examples of this.

; bIsSecretGoal : This actor will count in the [[Legacy:GameInfo_%28UT%29#game_goals|list of secrets]]. I can't think of any examples of this that are used in Unreal or Unreal Tournament.

; bMovable : This actor is not just stuck in place; it can move or be moved around the level. Some [[Legacy:Decoration|Decoration]]s are movable and some aren't. [[Legacy:NavigationPoint|NavigationPoint]]s are never movable. [[Legacy:Pawn (UT)|Pawn (UT)]]s are almost always movable.

; bNetOptional : [[Legacy:Replication|Replication]] – In online games, it can sometimes be necessary to forego the replication of some relevant actors. In such a case, the list needs to be pruned further, and actors that are bNetOptional are of a type that should only be replicated to clients if there is enough bandwidth for it.

; bNetTemporary : [[Legacy:Replication|Replication]] – Tear-off simulation in network play. When set to true, the actor and its variables are replicated only when it is first spawned. Thereafter everything is handled client-side – and no longer relevant to the server, which retains its own, game-relevant copy – thus preventing excessive bandwidth consumption. Generally used with actors which adhere to movement which can be predicted solely by standard physics types or client-side calculation (noncontrollable projectiles, decorations, effects).

; bNoDelete : This actor cannot be deleted during play. For most actors, this is ''False''. [[Legacy:Pawn (UT)|Pawn (UT)]]s, some [[Legacy:Decoration|Decoration]]s, and [[Legacy:Triggers (UT)|Triggers (UT)]] can be deleted, but such things as [[Legacy:Brush|Brush]]es and [[Legacy:NavigationPoint|NavigationPoint]]s should not be deleted.

; bOnlyOwnerSee : If an actor has an owner, then this owner is the only other actor that can see it.

; bOwnerNoSee : If an actor has an owner, then this owner is prevented from seeing the actor. This property is used for the [[Legacy:ShieldBeltEffect|ShieldBeltEffect]], for instance.

; bStasis : This actor is capable of entering stasis. In standalone games, an actor that doesn't need to be updated because of the player's location can enter stasis, especially if its physics is nonexistent or the actor is simply rotating in place.

; bStatic : This actor doesn't move or change at all over the course of time. [[Legacy:PathNode|PathNode]]s are bStatic, for example, because they don't need to be updated during the game, thus saving processing resources. '''Note:''' Neither Tick nor Timer are executed for bStatic actors. '''''Another Note:''''' '''Never''' use this to prevent items from rotating. There's the '''bRotatingPickup''' property for a reason, so use it.

; bTravel : This actor is capable of travelling between levels and between servers. This is pretty much only ''True'' for such things as [[Legacy:PlayerPawn|PlayerPawn]]s and [[Legacy:Inventory (UT)|Inventory (UT)]] items.

; LifeSpan : This is a float that tells how many seconds the object gets to exist before it is automatically destroyed. Most actors have a LifeSpan of 0.0, which means that they are allowed to exist forever. However, some things such as [[Legacy:Effects (UT)|Effects (UT)]] and [[Legacy:Projectile (UT)|Projectile (UT)]]s do have a definite LifeSpan.

'''Evilmrfrank:''' Ayone have any clue how to get the directional property to work in the classic UT? I have tried to use it a number of times but it never seems to work correctly.

'''Xian:''' From what I know, it's used by UED mostly to set the initial rotation of an actor (say the AmbushSpot). Tell me what you need/want to do and I'll do my best to explain it as clear as possible :)

'''Evilmrfrank:''' I have needed it for many things in UT from teleporters, to playerstarts, etc. According to this article you only need to change the setting to bdirectional=true, but that doesnt work.... I never see any red arrow like I do in Unreal Ed 3.0

'''Xian:''' Tried it on a weapon and the arrow appeared.

==Related Topics ==
* [[Legacy:Actor Overview|Actor overview]]

Legacy:GameInfo (UT)

2017-04-09T05:18:12Z

SeriousBarbie: added anchor

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Object|Object]] >> [[Legacy:Actor|Actor]] >> [[Legacy:Info (UT)|Info (UT)]] >> GameInfo (Package: Engine)}}

A GameInfo subclass contains the rules for a gametype. This includes timelimit, fraglimit, scoring, difficulty, game speed, allowed playerpawn classes, default inventory assignment, and if appropriate, team assignment and general bot behavior.

This is assigned to a map in the [[Legacy:Level Properties|Level Properties]] window, under LevelInfo -> DefaultGameType.

The <tt>GameInfo</tt> for the current game can be retrieved from every actor in that game via <tt>Level.Game</tt>, but ''only'' on the server. <tt>GameInfo</tt> is not replicated to network clients; only [[Legacy:GameReplicationInfo (UT)|GameReplicationInfo (UT)]] is.

See [[Legacy:GameInfo|GameInfo]] for the UT200x version of this class.

==Properties==

===Globalconfig Properties===
; bool bMuteSpectators : Whether spectators are allowed to speak.
; bool bLowGore : Whether or not to reduce gore.
; bool bVeryLowGore : Greatly reduces gore.
; bool bNoCheating : Disallows cheating. Hehe.
; bool bAllowFOV : Allows FOV changes in net games
; bool bExternalBatcher :
; float AutoAim : How much autoaiming to do (1 = none, 0 = always). (cosine of max error to correct)
; float GameSpeed : Scale applied to game rate.
; int MaxSpectators : Maximum number of spectators.
; private string AdminPassword : Password to receive bAdmin privileges.
; private string GamePassword : Password to enter game.
; int MaxPlayers :
; string ServerLogName : Server Log
; bool bLocalLog :
; bool bWorldLog :
; bool bBatchLocal :
; int DemoBuild :
; int DemoHasTuts :
; string IPPolicies[50] :

===Config Properties===
; bool bNoMonsters : Whether monsters are allowed in this play mode.
; bool bHumansOnly : Whether non human player models are allowed.
; bool bCoopWeaponMode : Whether or not weapons stay when picked up.
; bool bClassicDeathmessages : Weapon deathmessages if false.

===Localized Properties===
; bool bAlternateMode :
; string SwitchLevelMessage :
; string DefaultPlayerName :
; string LeftMessage :
; string FailedSpawnMessage :
; string FailedPlaceMessage :
; string FailedTeamMessage :
; string NameChangedMessage :
; string EnteredMessage :
; string GameName :
; string MaxedOutMessage :
; string WrongPassword :
; string NeedPassword :
; string IPBanned :

===Other Properties===
; int ItemGoals, KillGoals, SecretGoals : Special game goals.
; byte Difficulty : In Unreal: 0=easy, 1=medium, 2=hard, 3=very hard. In UT: 0=Novice, 1=Average, 2=Experienced, 3=Skilled, 4=Adept, 5=Masterful, 6=Inhuman, 7=Godlike.
; bool bRestartLevel :
; bool bPauseable : Whether the level is pauseable.
; bool bCanChangeSkin : Allow player to change skins in game.
; bool bTeamGame : This is a teamgame.
; bool bDeathMatch : This game is some type of deathmatch (where players can respawn during gameplay)
; bool bGameEnded : set when game ends
; bool bOverTime :
; bool bCanViewOthers :
; float StartTime :
; class<[[Legacy:PlayerPawn|PlayerPawn]]> DefaultPlayerClass :
; class<[[Legacy:Weapon (UT)|Weapon (UT)]]> DefaultWeapon : Default weapon given to player at start.
; int NumSpectators : Current number of spectators.
; class<[[Legacy:ScoreBoard|ScoreBoard]]> ScoreBoardType : Type of scoreboard this game uses.
; class<[[Legacy:Menu|Menu]]> GameMenuType : Type of oldstyle game options menu to display.
; string BotMenuType : Type of bot menu to display.
; string RulesMenuType : Type of rules menu to display.
; string SettingsMenuType : Type of settings menu to display.
; string GameUMenuType : Type of Game dropdown to display.
; string MultiplayerUMenuType : Type of Multiplayer dropdown to display.
; string GameOptionsMenuType : Type of options dropdown to display.
; class<[[Legacy:HUD (UT)|HUD (UT)]]> HUDType : HUD class this game uses.
; class<[[Legacy:MapList|MapList]]> MapListType : Maplist this game uses.
; string MapPrefix : Prefix characters for names of maps for this game type.
; string BeaconName : Identifying string used for finding LAN servers.
; string SpecialDamageString :
; int SentText :
; int NumPlayers :
; int CurrentID :
; class<[[Legacy:LocalMessage (UT)|LocalMessage (UT)]]> DeathMessageClass :
; class<[[Legacy:LocalMessage (UT)|LocalMessage (UT)]]> DMMessageClass : A message class to be used for commonly used messages. For example, the [[Legacy:DeathMatchPlus|DeathMatchPlus]] gametype sets [[Legacy:DeathMatchMessage|DeathMatchMessage]] as the default, which contains messages for overtime, players leaving and joining the game, players changing names, and players switching teams.
; class<[[Legacy:Mutator|Mutator]]> MutatorClass : Class of this gametype's base mutator. (Default is Engine.[[Legacy:Mutator|Mutator]], [[Legacy:DeathMatchPlus|DeathMatchPlus]] uses Botpack.[[Legacy:DMMutator|DMMutator]].)
; [[Legacy:Mutator|Mutator]] BaseMutator :
; [[Legacy:Mutator|Mutator]] DamageMutator : [[Legacy:Linked List|Linked list]] of mutators which affect damage.
; [[Legacy:Mutator|Mutator]] MessageMutator : [[Legacy:Linked List|Linked list]] of mutators which get localized message queries.
; class<[[Legacy:ZoneInfo|ZoneInfo]]> WaterZoneType : Default waterzone entry and exit effects
; name DefaultPlayerState : What state a player should start in for this game type
; class<[[Legacy:GameReplicationInfo|GameReplicationInfo]]> GameReplicationInfoClass :
; [[Legacy:GameReplicationInfo|GameReplicationInfo]] GameReplicationInfo :
; [[Legacy:StatLog|StatLog]] LocalLog :
; [[Legacy:StatLog|StatLog]] WorldLog :
; bool bLoggingGame : Does this gametype log?
; string LocalLogFileName :
; string WorldLogFileName :
; class<[[Legacy:StatLog|StatLog]]> StatLogClass :
; string EnabledMutators : Server query info

==Methods ==
; AdminLogin ([[Legacy:PlayerPawn|PlayerPawn]] P, string Password) : This function will allow a player to log in as the administrator if the password entered is correct. The function also broadcasts a notification message to the other players.
; AdminLogout ([[Legacy:PlayerPawn|PlayerPawn]] P) : This function is called when a player leaves administrator mode. It ensures that the player is forced to "Walk", and kills them. There is code in there to preserve the players score when they die from logging out of admin mode but I'm sure it doesn't work in practice. – must check.
; InitLogging ( ) : Called from <tt>PostBeginPlay()</tt>. Logs more stuff than you can shake a big stick at. Calls functions on the WorldLog, Log, and LocalLog objects to do so.
; InitGameReplicationInfo ( ) : This function is responsible for placing the values of the attributes of the GameInfo class important to the client onto the [[Legacy:GameReplicationInfo|GameReplicationInfo]] object.
; string GetInfo ( ) : Returns the status of the World log.
; string GetRules ( ) : This function builds up a description of the server from the list of mutators currently in use, the type of server (Listen or otherwise), and whether there is a password on the server or not.
; int GetServerPort ( ) : This functon returns the port the server is runing on by interrogating the level URL.
; bool SetPause (bool bPause, [[Legacy:PlayerPawn|PlayerPawn]] P) : If the level can be paused then the player who paused the game is stored and the function returns ''true''. If the game is not pausable then the function will return ''false''.
; LogGameParameters ([[Legacy:StatLog|StatLog]] StatLog) : This function writes the general game parameters to the <tt>StatLog</tt>.
; SetGameSpeed (float T) : This function sets the game speed (but never below 0.1).
; bool IsRelevant ([[Legacy:Actor|Actor]] Other) : This function is called from any [[Legacy:Actor|Actor]]'s <tt>PreBeginPlay()</tt>. If this function returns ''true'' the actor continues to exist. If the function returns ''false'' the actor is removed from the game. This function calls the <tt>AlwaysKeep()</tt> and <tt>IsRelevant()</tt> functions on any mutators within the game prior to checking actor difficulty levels and "odds of appearing" values. The function also counts the number of remaining <tt>SecretGoals</tt>, <tt>ItemGoals</tt>, and <tt>KillGoals</tt> left within the level (also see [[Legacy:Creating Actors And Objects|Creating Actors And Objects]]).
; bool GrabOption (out string Options, out string Result) : Grabs the next left option from a string. ''Result'' contains the part between the first "?" and the next "?" (if exist). ''Result'' is removed then from ''Options''. If ''Options'' starts with "?", ''true'' is returned, otherwise ''false''.
; GetKeyValue (string Pair, out string Key, out string Value) : Break up a ''key=value'' pair into its key and value.
; bool HasOption (string Options, string InKey) : See if an option was specified in the options string.
; string ParseOption (string Options, string InKey) : Find the most left option of kind "''InKey''=Value" in ''Options'' and returns ''Value'' if ''InKey'' has been found, an empty string else. ''Options'' stays unchanged.
; ProcessServerTravel (string URL, bool bItems) : Called when a map changes. Is responsible for handling the transfer of players and their inventory as well as ensuring that all logging for the level just played is tidied up.
; bool AtCapacity (string Options) : This function returns ''true'' if the server has the maximum number of players allowed on it.
; bool CheckIPPolicy (string Address) : Returns ''true'' if the IP address of the client is allowed to connect to the server.
; int GetIntOption( string Options, string ParseString, int CurrentValue ) : Same as '''ParseOption''' but returns an Integer. If the key ''ParseString'' is not found, ''CurrentValue'' is returned.
; Logout ([[Legacy:Pawn (UT)|Pawn (UT)]] Exiting) : Logs the player out and tells the logging engine about it.
; AddDefaultInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn) : Add any default inventory to the player.
; NavigationPoint FindPlayerStart ([[Legacy:Pawn (UT)|Pawn (UT)]] Player, optional byte InTeam, optional string incomingName) : Locates the "best" player start for the player.
; bool RestartPlayer ([[Legacy:Pawn (UT)|Pawn (UT)]] aPlayer) : Restart a player after he has died. This function adds the default inventory by calling <tt>AddDefaultInventory()</tt>, finds a start location by calling <tt>FindPlayerStart()</tt>. Once this has been acomplished, sets the player's stats back to defaults.
; StartPlayer ([[Legacy:PlayerPawn|PlayerPawn]] Other) : Start a player. Finish me
; Killed ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other, name damageType) : Called when someone gets killed. This function broadcasts the death message, logs the event, and calls the <tt>ScoreKill()</tt> function.
; BroadcastRegularDeathMessage ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other, name damageType) : Calls on to <tt>BroadcastLocalizedMessage()</tt>.
; ScoreKill ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) : Increases the Killer's killCount and score by 1 unless it was a suicide - in which case the killed pawn loses a point.
; string KillMessage (name damageType, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) [static] : Returns " died." as a default catch all death message.
; bool CanSpectate ([[Legacy:Pawn (UT)|Pawn (UT)]] Viewer, [[Legacy:Actor|Actor]] ViewTarget) : Returns whether ''Viewer'' is allowed to use ''ViewTarget'' as its point of view. GameInfo's return value is unconditionally ''true''.
; RegisterDamageMutator ([[Legacy:Mutator|Mutator]] M) : Adds a damage mutator at the front of the list of damage mutators.
; RegisterMessageMutator ([[Legacy:Mutator|Mutator]] M) : Adds a message mutator at the front of the list of message mutators.
; int ReduceDamage (int Damage, name DamageType, [[Legacy:Pawn (UT)|Pawn (UT)]] injured, [[Legacy:Pawn (UT)|Pawn (UT)]] instigatedBy) : This function returns a damage of 0 if the injured [[Legacy:Pawn (UT)|Pawn (UT)]] is in a zone that has it's <tt>bNeutralZone</tt> property set to ''true''. Otherwise the original damage is returned.
; bool ShouldRespawn ([[Legacy:Actor|Actor]] Other) : Returns whether an actor item should respawn. In death matches this function should return ''true'' for weapon and item pickups.
; bool PickupQuery ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, [[Legacy:Inventory (UT)|Inventory (UT)]] Item) : Called when pawn has a chance to pick Item up (i.e. when the pawn touches a weapon or item pickup). Should return ''true'' if it is allowed to pick it up, ''false'' if not.
; DiscardInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] Other) : Discard a player's inventory after he dies.
; float PlayerJumpZScaling ( ) : Returns 1.0, but could be overidden for "low grav" game types.
; ChangeName ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, coerce string S, bool bNameChange) : Attempt to change a players name.
; bool ChangeTeam ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, int N) : Return whether a player can change teams or not.
; float PlaySpawnEffect ([[Legacy:Inventory (UT)|Inventory (UT)]] Inv) : Play an inventory respawn effect.
; string PlayerKillMessage (name damageType, [[Legacy:PlayerReplicationInfo|PlayerReplicationInfo]] Other) [static] : returns " was killed by ".
; string CreatureKillMessage (name damageType, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) [static] : returns "was killed by a "
; SendPlayer ([[Legacy:PlayerPawn|PlayerPawn]] aPlayer, string URL) : Send the player specified to the URL passed to the function.
; RestartGame ( ) : Called to restart the current game.
; bool AllowsBroadcast ([[Legacy:Actor|Actor]] broadcaster, int Len) : Returns ''true'' if the [[Legacy:Actor|Actor]] passed to the function is allowed to broadcast a message.
; EndGame (string Reason) : Called at the end of the game. If first calls <tt>BaseMutator.HandleEndGame()</tt> and <tt>SetEndCams()</tt> and if both returns ''false'' game is not ended but <tt>bOverTime</tt> set to ''true''. Otherwise <tt>bGameEnded</tt> is set to ''true'', the event 'EndGame' is risen and game logging is closed down.
; bool SetEndCams (string Reason) : Puts all player pawns into a ''GameEnded'' state and calls the <tt>ClientGameEnded()</tt> function on them. The function returns ''true''.
; ResetGame ( ) [static] : GameInfo's <tt>ResetGame( )</tt> does nothing. In Game type ''Assault'' it is overridden and some default values are reset and saved there.
; bool AddBot ( ) : GameInfo's <tt>AddBot( )</tt> does nothing. It is overwitten in derivied game types, for example in ''DeathMatchPlus''.
; bool ForceAddBot ( ) : GameInfo's <tt>ForceAddBot( )</tt> does nothing. It is overridden in ''DeathMatchPlus''.
; PlayTeleportEffect ([[Legacy:Actor|Actor]] Incoming, bool bOut, bool bSound) : It is intended to play a teleporting special effect, but GameInfo's <tt>PlayTeleportEffect( )</tt> does nothing. Overridden for example in ''DeathMatchPlus''.

===Native Functions ===
; string GetNetworkNumber() : (unknown)
; string ParseKillMessage (string KillerName, string VictimName, string WeaponName, string DeathMessage) [static] : Parses the kill message. Replaces the first occurances of <tt>%k</tt>, <tt>%o</tt> and <tt>%w</tt> with <tt>KillerName</tt>, <tt>VictimName</tt> and <tt>WeaponName</tt> respectively (also see [[Legacy:Message Placeholder|Message Placeholder]]).

===Events ===
; GameEnding ( ) : This functon is called when a game is shut down. It halts any world logging and local logging.
; DetailChange ( ) : This function is called whenever the client changes their level of detail (high to low, or low to high). Apart from re-linking all of the zones to a SkyBox, any actors with their <tt>bHighDetailMode</tt> property set to ''true'' will be destroyed on entry to a "low detail" mode.
; InitGame (string Options, out string Error) : This function is called before the [[Legacy:Actor|Actor]]s <tt>PreBeginPlay()</tt> function. It sets up some of the game options and spawns the [[BaseMutator]].
; string GetBeaconText ( ) : Returns ''Level.ComputerName'', the length truncated ''Level.Title'', the ''BeaconName'' and the number of players and ''MaxPlayers''. Used by <tt>UdpBeacon.BroadcastBeacon()</tt>.
; PreLogin (string Options, string Address, out string Error, out string FailCode) : Accepts or rejects a player based upon any game password validation, IP bans, and current server capacity.
; [[Legacy:PlayerPawn|PlayerPawn]] Login (string Portal, string Options, out string Error, class<[[Legacy:PlayerPawn|PlayerPawn]]> SpawnClass) : Log a player in. Fails login if you set the Error string. <tt>PreLogin()</tt> is called before <tt>Login()</tt>, but significant game time may pass before <tt>Login()</tt> is called, especially if content is downloaded.
; PostLogin ([[Legacy:PlayerPawn|PlayerPawn]] NewPlayer) : Called after a successful login. This is the first place it is safe to call replicated functions on the PlayerPawn. finish me
; AcceptInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn) : Called when new inventory is accepted. Calls the function <tt>AddDefaultInventory()</tt>.
; ScoreEvent (name EventName, [[Legacy:Actor|Actor]] EventActor, [[Legacy:Pawn (UT)|Pawn (UT)]] InstigatedBy) : Intended to award a score to an actor. GameInfo's <tt>ScoreEvent()</tt> does nothing.

==Known subclasses ==
* [[Legacy:UnrealGameInfo|UnrealGameInfo]]
* [[Legacy:TournamentGameInfo|TournamentGameInfo]]

==Comments ==

We could do with a nice time diagram showing when all of the different functions and events (including those on the mutators) get called.

==Related Topics ==

See [[Legacy:Function Syntax|Function Syntax]] and [[Legacy:Variable Syntax|Variable Syntax]] for additional background information.

----

[[:Category:Legacy Class (UT)]]

----

'''Fearless''': Hmmm, some interesting information here even if it's basic. I'd really like to do a mutator that changes gamespeed without the intervention of an admin. I have also a little question concerning the adminlogout command. It says here that the player is killed when the command is invoked. This does happen on our Linux 4.40 server but this doesn't happen on a server you're hosting yourself. Does anyone have any idea why this is :P ?

'''NogginBasher''': You can do that using a combination of x3dfxMapVote and IdeFiX's ServerMode. In ServerMode.ini you need something like: "Commands[11]=SET Engine.GameInfo GameSpeed 1.25". I'm currently testing: "Commands[12]=SET Botpack.DeathMatchPlus bHardcoreMode True"
[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:UMOD Extractor

2017-02-08T01:58:09Z

SeriousBarbie: URL has changed

[http://www.acordero.org/projects/unreal-tournament-umod-extractor/ UMOD Extractor]

Legacy:T3D File

2017-01-27T03:42:34Z

SeriousBarbie: removed my signature - seems I put it accidentally there

The '''T3D file format''' or '''Unreal Text File''' holds a text list of Unreal map objects. An entire map can be saved as this file format, or just a single actor or brush.

Note that while brushes, their applied textures and light actors are saved, the [[Legacy:Unreal Geometry|Unreal Geometry]] itself is not saved: upon importing a T3D file the map must be built.

Copying objects from UnrealEd and pasting into a text editor produces the same format.

Unreal Text format

Exported brushes and (other) actors. See [[Legacy:T3D File|T3D file]].
* Created by:
** UnrealEd's File -> Import command
** UnrealEd's Brush -> Import command (see [[Legacy:Data Import And Export|Data Import and Export]] for more on both these commands).
** is this created by external stuff too?

===Exporting T3D ===
* Export the whole map
** File -> Export... (UnrealEd 1,2,3)
** File -> Export -> All.. (UnrealEd 4 - UT3)
* Export selected actors: File-> Export-> Selected Only ... (UnrealEd 4 only - UT3)
* Export one brush: Brush -> Export ...
* Copy/Paste: can copy paste any actor from any UnrealEd version to another one (Except for UnrealEd 4) or to any text editor such as notepad (Windows)

===Importing T3D ===

File -> Import...

(note importing may take a LONG time)

Overheard on #utjb... :-)

<tarquin> t3d stores brushes & actors but not texturing, right?
<Mychaeel> Texturing as well.
(melds into the opening speech from Reservoir Dogs...)
<DaveA>Stores links to textures, and texture transforms, but not the pixels themselves

The T3D format is a text file which stores information about map actors. It's in fact identical to what can be copied from UnrealEd to a text editor. An exported map looks like this:

<uscript>
Begin Map
Begin Actor Class=LevelInfo Name=LevelInfo0
TimeSeconds=17.008888
Summary=LevelSummary'Entry.LevelSummary'
DefaultGameType=Class'Botpack.UTIntro'
AIProfile(0)=23784352
AIProfile(1)=52
AIProfile(2)=41
AIProfile(3)=42
AIProfile(4)=40
AIProfile(5)=44
AIProfile(6)=45
AIProfile(7)=21846171
AvgAITime=0.000000
Level=LevelInfo'Entry.LevelInfo0'
Tag=LevelInfo
Region=(Zone=LevelInfo'Entry.LevelInfo0',iLeaf=-1)
Name=LevelInfo0
End Actor
Begin Actor Class=Brush Name=Brush0
MainScale=(SheerAxis=SHEER_ZX)
PostScale=(Scale=(X=0.250000,Y=8.000000,Z=3.000000),SheerAxis=SHEER_ZX)
TempScale=(Scale=(X=0.250000,Y=8.000000,Z=3.000000),SheerAxis=SHEER_ZX)
Level=LevelInfo'Entry.LevelInfo0'
Tag=Brush
Region=(Zone=ZoneInfo'Entry.ZoneInfo0',iLeaf=1,ZoneNumber=1)
Location=(X=464.000000,Y=-16.000000,Z=64.000000)
Begin Brush Name=Brush
Begin PolyList
Begin Polygon Item=OUTSIDE Texture=black1 Flags=4194304 Link=0
Origin -00160.000000,+00000.000000,+00128.000000
Normal +00000.000000,+00000.000000,+00001.000000
TextureU +00004.000000,+00000.000000,+00000.000000
TextureV +00000.000000,+00004.000000,+00000.000000
Vertex -00128.000000,-00128.000000,+00128.000000
Vertex +00128.000000,-00128.000000,+00128.000000
Vertex +00128.000000,+00128.000000,+00128.000000
Vertex -00128.000000,+00128.000000,+00128.000000
End Polygon
...
End PolyList
End Brush
Brush=Model'Entry.Brush'
Name=Brush0
End Actor
Begin Actor Class=PlayerStart Name=PlayerStart0
Level=LevelInfo'Entry.LevelInfo0'
Tag=PlayerStart
Region=(Zone=ZoneInfo'Entry.ZoneInfo0',iLeaf=1,ZoneNumber=1)
Location=(X=183.134430,Y=-987.334167,Z=33.978027)
OldLocation=(X=-217.561523,Y=-44.538128,Z=-87.899948)
Name=PlayerStart0
End Actor
...
End Map</uscript>

External link: http://web.archive.org/web/20060710080159/http://unreal.jall.org/tutorials/t3d.html (new URL)

=== T3D File Structure ===
== Ux,UT,UT200x Maps ==
<uscript>
Begin Map
Begin Actor Class=<ClassName>
...
End Actor
Begin Actor Class=<ClassName>
...
End Actor
...
End Map
</uscript>

== UT3 Maps ==
<uscript>
Begin Map
Begin Level NAME=PersistentLevel
Begin Actor Class=<ClassName>
...
End Actor
Begin Actor Class=<ClassName>
...
End Actor
...
End Level
Begin Surface
End Surface
End Map
</uscript>

Note: as UT3 T3D files have different header, any other not-UT3 t3d file can't be imported into UT3 editor (UnrealEd 4)

===T3D brush geometry===
Information geometry is contained in the following actors:
*Brush
*Mover (only UT and U1 game)

For more information about T3D brushes, see [[Legacy:T3D_Brush|T3D Brush]].

==T3D Utilities ==
* [[Legacy:MapScale|MapScale]] scales an entire .t3d file
* [[Legacy:MeshMaker|MeshMaker]] converts a prefab in .t3d format to a [[Legacy:Decoration|decoration]]
* [http://darendash.home.comcast.net/~darendash/Converter.html UnrealROC] converters: from 3DMF, to VRML/X3D/OBJ (including textures et al).

==Related Topics ==
* [[Legacy:Data Import And Export|Data Import and Export]]
* [[Legacy:Brush Exporting And Importing|Brush Exporting And Importing]]
* [[Legacy:Brush Hacking|Brush Hacking]]
* [[Legacy:T3D Brush|T3D Brush]]

'''Kefik:''' There can be also a tag 'CsgOper' which have one of two values ... 'CSG_Subtract' -> subtract the brush from space or 'CSG_Add' -> add this brush to shape.

'''Sobiwan:''' New to WIKI editing, but not using it. I was searching for the actual format of T3D and found 
[http://web.archive.org/web/20050913035722/http://users.skynet.be/fa550206/Slug-Production/Data/OpenGL-Documents/T3D-File-Format/T3D-File-Format.htm Mongo's description] of [http://www.planetunreal.com Planetunreal] to be extremely helpful. I'll ask him (mongo@planetunreal.com) if we can use and/or edit his description here. The format is much more involved than described here. We can even supply examples of how to do particular hacks.

'''MadNad:''' Interestingly, I was able to convert a [http://madnad.com/ut2k3/Screenshots/q3dm7.jpg?link Quake3_Level] into a unreal map. Quite interesting. First i converted a *.bsp to a *.map in quake, then I made a level that was just a huge cube and converted it to *.t3d. With an external app (i'll have to find the name of it ) I was able to merge these two together. After some scaling and switching additive brushes in quake to subtractive brushes in ued and subtractive to additive, I compiled and had q3dm7 geometry. I don't necessarily recommend doing this, as it will take more time to fix than create it from scratch, but I thought I would share a little experience I had with this.

Legacy:Pivot

2017-01-08T02:14:42Z

SeriousBarbie: Pivot Tips: modifying PrePivot without GUI

The "pivot" of any [[Legacy:Actor|actor]] is essentially its "center" - though it may not coincide with the geographical center of the graphics rendered for that actor. Usually static meshes and brushes are more or less centered around their pivot, but this is not necessarily the case. The pivot, when visible, (in the editor) is displayed as a small red cross.

The Movement -> Location property of an actor refers to the location of its pivot. The ''PrePivot'' property of an actor is the vector offset of the pivot from its location stored in its mesh, or the center of its sprite – sort of. It is actually the opposite, the vector offset of the mesh/sprite from the pivot. This can be useful if a mesh or sprite snaps to the grid but the part of the mesh/sprite that snaps to the grid is not the part you wanted snapped. Brushes also have a pivot, but the pivot can be moved within the editor, making the PrePivot property less of an issue for Brushes.

The pivot is considered the center point of the actor, and as such is also the point that is rotated around when the actor is rotated. Also the AmbientSound is emitted there.

==Setting the pivot==

There are several ways to set the pivot point:
* Right-clicking a vertex of a selected brush will put the pivot point of that brush to that vertex.
* [[Legacy:Brush Context Menu|Brush Context Menu]] -> Pivot -> Place pivot snapped here. This will snap the pivot point to the grid where you click on a 2D viewport.
* [[Legacy:Brush Context Menu|Brush Context Menu]] -> Pivot -> Place pivot here. This will place the pivot point exactly where you click on a 2D viewport without considering the grid.

Right clicking a vertex will set it correctly. If you need the pivot point inside the brush and not exactly on a vertex, you can bring up the brush's properties and alter the Display->PrePivot numbers directly. The PrePivot determines the brush's offset from the pivot point.

==Pivot Tips==
* If a brush swings off into the distance when rotating, then it's probably because the pivot has somehow been placed far away.
* When rotating a group of brushes together, check that the pivot hasn't ended up off the grid. You can also save time by placing it before rotating.
* If when you try to move the red brush (using shift) and it moves the pivot instead, try to change the red brush properties -> Advanced -> lock location to false.
* In UnrealEd2.0 you PrePivot is not shown in the GUI and therefore not editable. But you can cut the Actor, paste it into an text editor, delete that line with ''PrePivot'', copy that to clipboard and paste it to UnrealEd.

==Pivot Points and Movers==

It's also the point about which a [[Legacy:Mover|mover]] will rotate if there is a difference in orientation between successive keys. In UnrealEngine1 all keys of a mover must have the same pivot point. ''We don't know if this still holds true for newer engine versions.''

==Related Topics==
* [[Legacy:Actor/Display|Actor/Display]] – PrePivot.

==Discussion==

[[Category:Legacy Mapping|{{PAGENAME}}]]

Legacy:DeathMatchPlus

2017-01-04T00:42:52Z

SeriousBarbie: added some infos

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Info (UT)|Info (UT)]] >> [[Legacy:GameInfo (UT)|GameInfo (UT)]] >> [[Legacy:TournamentGameInfo|TournamentGameInfo]] >> DeathMatchPlus (Package: BotPack)}}

This is the Tournament DeathMatch gametype and at the same time the superclass of all other "playable" UT game types.

==Properties ==

===Globalconfig Properties ===

These settings are shared among all UT game types.
; globalconfig int MinPlayers : Bots fill the server to guarantee this minimum number of players.
; globalconfig float AirControl : The default air control.
; globalconfig bool bChangeLevels :
; globalconfig bool bHardcoreMode : If this is True players receive 50% more damage and jump 10% higher. Game time goes by 10% faster.
; globalconfig bool bMegaspeed : Players move 40% faster and jump 20% higher than without bMegaSpeed and bHardcoreMode.
; globalconfig bool bAltScoring : If a player is killed by another player his score is reduced by 1 point.
; globalconfig bool bTournament : True if Tournament mode is enabled. Tournament mode prevents the game from starting until every player has indicated that they are ready (even if the "non ready" players have nipped down the chippy for some food).
; globalconfig int NetWait : Time to wait for players in netgames w/ bNetReady (typically team games)
; globalconfig int RestartWait :
; globalconfig int InitialBots :

===Config Properties ===

Per-gametype settings.
; config int FragLimit : Pretty obvious.
; config int TimeLimit : Time limit in minutes.
; config bool bMultiWeaponStay : Weapons stay when they are picked up. (No respawn time)
; config bool bForceRespawn : Players respawn instantly. (Configured in the Settings tab of the Start Game window.)
; config int MaxCommanders :
; config bool bUseTranslocator : Whether players should get a [[Legacy:Translocator|Translocator]].

===Localized Properties ===
; string StartUpMessage :
; string TourneyMessage :
; string WaitingMessage1 :
; string WaitingMessage2 :
; string ReadyMessage :
; string NotReadyMessage :
; string CountDownMessage :
; string StartMessage :
; string GameEndedMessage :
; string SingleWaitingMessage :
; string gamegoal :
; string NoNameChange :
; string OvertimeMessage :

===Other Properties ===
; bool bChallengeMode : Game time goes by even faster. (25%)
; bool bAlwaysForceRespawn : Overrides bForceRespawn to be always True. This is a gametype specific setting and can not be configured.
; bool DontRestart : ???
; bool bAlreadyChanged : ???
; bool bFirstBlood : This indicated whether ''First Blood'' was already drawn.
; bool bRequireReady :
; bool bNoviceMode : This will be set when Difficulty is below 4.
; bool bNetReady :
; bool bJumpMatch : All Players can jump as high as if they had the jump boots.
; bool bThreePlus : This will be set when Difficulty is not >= 4, but > 3. (this doesn't seem to be possible though, since Difficulty is a byte variable)
; bool bFulfilledSpecial : Not used in DeathMatchPlus and always set to ''true'' in some sub classes (TeamGamePlus for or CTFGame for example). Can be used in custom game types with special conditions for a successful game.
; bool bRatedTranslocator : Use the Translocator in in this rated game, i.e. ladder game.
; bool bStartMatch : Is set to ''true'' while function <tt>StartMatch()</tt> is running.
; int RemainingTime, ElapsedTime :
; int CountDown, StartCount :
; float LastTauntTime :
; [[Legacy:NavigationPoint|NavigationPoint]] LastStartSpot :
; int NumCommanders : Number of Commanders in the game. ''(Commanders are not implemented in UT)''
; bool bTutorialGame : This game is a tutorial game.
; int NumBots : Number of bots in the game.
; int RemainingBots :
; int LastTaunt[4] : The indices of the last four auto-taunts used, LastTaunt[3] being the most recent. This is generally updated by the Killed() function.
; [[Legacy:ChallengeBotInfo|ChallengeBotInfo]] BotConfig :
; class<[[Legacy:ChallengeBotInfo|ChallengeBotInfo]]> BotConfigType :
; float PlayerRating :
; float AvgOpponentRating :
; int NumOpp :
; int WinCount :
; int LoseCount :
; [[Legacy:PlayerPawn|PlayerPawn]] RatedPlayer :
; int IDnum :
; [[Legacy:RatedMatchInfo|RatedMatchInfo]] RatedMatchConfig :
; float EndTime :
; int LadderTypeIndex :
; [[Legacy:LadderInventory|LadderInventory]] RatedGameLadderObj :

==Methods ==
; PreCacheReferences ( ) : This function is never called. It exists purely to force the pre-caching of the standard weapon and player meshes. The Arena mutators thereby force the pre-caching of weapon meshes that are not even used.
; CheckReady ( ) : This function sets the <tt>TimeLimit</tt> to 20, and the <tt>RemainingTime</tt> to 1200. The function is only called when tournament mode is turned on.
; SetGameSpeed (float T) : This function sets the gamespeed. It completely replaces the superclass implementation. The function also calls <tt>SaveConfig()</tt> once the final game speed has been calculated.
; PlayTeleportEffect ([[Legacy:Actor (UT)|Actor (UT)]] Incoming, bool bOut, bool bSound) : Originally declared in [[Legacy:GameInfo (UT)|GameInfo (UT)]]. This function simply adds a check for tournament mode behaviour. Apart from that the code is identical to the [[Legacy:TournamentGameInfo|TournamentGameInfo]] version of this function. ''Note to newbie coders: This is an example of poor practice. After the initial tournament check the developer should simply have called <code>Super.PlayTeleportEffect()</code> - it would have saved the code duplication.''
; InitRatedGame ([[Legacy:LadderInventory|LadderInventory]] LadderObj, [[Legacy:PlayerPawn|PlayerPawn]] LadderPlayer) : Set game settings based on ladder information. Called when RatedPlayer logs in.
; AcceptInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn) : Originally declared in [[Legacy:GameInfo (UT)|GameInfo (UT)]]. This function allows the player to keep all instances of type [[Legacy:LadderInventory|LadderInventory]], and destroys all other inventory objects. The player's weapon and selected item are set to <tt>None</tt> and the function <tt>AddDefaultInventory()</tt> is called.
; bool SetEndCams (string Reason) : Plays the winning message and focuses the view on the winning player.
; PlayWinMessage ([[Legacy:PlayerPawn|PlayerPawn]] Player, bool bWinner) : Plays the winning message if the object passed is of type [[Legacy:TournamentPlayer|TournamentPlayer]].
; NotifySpree ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, int num) : Notifies the local player if they are on a killing spree - and selects an appropriate message. ''num'' is the number of kills the player has got without dying.
; EndSpree ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) : Unfortunately your killing spree has come to an end - lets tell both you and the person who killed you about it.
; Killed ([[Legacy:Pawn (UT)|Pawn (UT)]] killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other, name damageType) : Declared in [[Legacy:GameInfo (UT)|GameInfo (UT)]]. This function checks for any end of game conditions as well as for "first blood" and other special events. This function is also responsible for sending auto taunts.
; StartMatch ( ) : This is called to start the game. If there is a timelimit on the start of the game then this function sets that. There are also traps in here to end the game from spawn-telefrags (if there are not enough start points then it's possible to win a game just from telefragging).
; Timer ( ) : Checks for tournament mode, whether the game has ended because of it's time limit and other stuff.
; bool TooManyBots ( ) : This function returns <tt>true</tt> if the number of bots plus the number of players is greater than the minimum number of players.
; bool RestartPlayer ([[Legacy:Pawn (UT)|Pawn (UT)]] aPlayer) : Called to re-start a player on the map. Will also remove bot players from the game if there are too many of them.
; SendStartMessage( [[Legacy:PlayerPawn|PlayerPawn]] P ) : Shows the start message to the player.
; [[Legacy:Bot (UT)|Bot (UT)]] SpawnBot (out NavigationPoint StartSpot) : Spawns a bot. Finish me
; [[Legacy:Bot (UT)|Bot (UT)]] SpawnRatedBot (out [[Legacy:NavigationPoint|NavigationPoint]] StartSpot) : Finish me
; bool ForceAddBot ( ) : Finish me
; bool AddBot ( ) : Finish me
; PlayStartUpMessage ([[Legacy:PlayerPawn|PlayerPawn]] NewPlayer) : Finish me
; GiveWeapon ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn, string aClassName) : Gives a weapon to a player and makes it the player's current weapon.
; RateVs ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, [[Legacy:Pawn (UT)|Pawn (UT)]] Killer) : Finish me
; bool SuccessfulGame ( ) : Finish me
; Skip ( )
; SkipAll ( ) : Debug commands (?)
; bool NeedPlayers ( ) : Finish me
; bool OneOnOne ( ) : Returns whether there are only two players (human players or bots
; float SpawnWait ([[Legacy:Bot (UT)|Bot (UT)]] B) : Finish me
; bool NeverStakeOut ([[Legacy:Bot (UT)|Bot (UT)]] Other) : Finish me

==AI and Navigation Functions ==
; bool CheckThisTranslocator ([[Legacy:Bot (UT)|Bot (UT)]] aBot, [[Legacy:TranslocatorTarget|TranslocatorTarget]] T) : This function returns ''false''.
; PickAmbushSpotFor ([[Legacy:Bot (UT)|Bot (UT)]] aBot) : This function searches through all [[Legacy:NavigationPoint|NavigationPoint]] objects on the map looking for navigation points of type [[Legacy:AmbushPoint|AmbushPoint]]. If the [[Legacy:AmbushPoint|AmbushPoint]] is not taken ([[Legacy:NavigationPoint|NavigationPoint]].taken is ''false'') and the [[Legacy:Bot (UT)|Bot (UT)]] is not already at an ambush point then the ambush point found will be assigned to the [[Legacy:Bot (UT)|Bot (UT)]].''AmbushSpot''. If the bot is already at an ambush point and a new ambush point has been found then the bot's ''AmbushSpot'' will be set to the new [[Legacy:AmbushPoint|AmbushPoint]].
; byte AssessBotAttitude ([[Legacy:Bot (UT)|Bot (UT)]] aBot, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) : This function determines the attitude of ''aBot'' towards ''Other''. The value returned by this function is used in [[Legacy:Bot (UT)|Bot (UT)]].AttitudeTo() function to map to the enumeration [[Legacy:EAttitude|eAttitude]]. The function returns either a 1 (hate) or a 0 (fear) depending on the result of it's calculations. The calculations involve the bot's skill and level of agressiveness as defined by the value of ''aBot.Aggressiveness''.
; float GameThreatAdd ([[Legacy:Bot (UT)|Bot (UT)]] aBot, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) : This function is called by Bot.AssessThreat() and returns a numerical value representing the importance of <tt>Other</tt> as a target. In DeathMatchPlus it simply returns 0, but individual gametypes override this function to gain more control over the bots' selection of targets. For example, the [[Legacy:CTFGame|CTFGame]] implementation of this function returns 10 if <tt>Other</tt> is a flag carrier, and [[Legacy:LastManStanding|LastManStanding]]'s version returns slightly higher threat values for players who have more lives left.
; bool AllowTranslocation ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, vector Dest) : This function returns ''true''.
; bool CanTranslocate ([[Legacy:Bot (UT)|Bot (UT)]] aBot) : This function returns true if the bot is able to perform a translocation. In order for the bot to be able to use the translocator it must first have one, and it's [[Legacy:Translocator|Translocator]] must have a target. Translocation must also be allowed by the game.
; ModifyBehaviour ([[Legacy:Bot (UT)|Bot (UT)]] NewBot) : Only declaration here.

==Comments ==

From what I can tell there is an awful lot of handling around the "Tournament Mode" feature.

==Known Subclasses ==
* [[Legacy:ChallengeDMP|ChallengeDMP]] (used for the "Challenge" group of ladder game?)
* [[Legacy:ChallengeIntro|ChallengeIntro]] (used for CityIntro map)
* [[Legacy:LastManStanding|LastManStanding]]
* [[Legacy:TDarkMatch|TDarkMatch]] (Tournament DarkMatch, not used)
* [[Legacy:TeamGamePlus|TeamGamePlus]]
* [[Legacy:TrainingDM|TrainingDM]]

==Related Topics ==
* [[Legacy:Mapping For DM|Mapping for DM]]

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:GameInfo (UT)

2016-12-31T16:38:23Z

SeriousBarbie: reworked and added some infos

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Object|Object]] >> [[Legacy:Actor|Actor]] >> [[Legacy:Info (UT)|Info (UT)]] >> GameInfo (Package: Engine)}}

A GameInfo subclass contains the rules for a gametype. This includes timelimit, fraglimit, scoring, difficulty, game speed, allowed playerpawn classes, default inventory assignment, and if appropriate, team assignment and general bot behavior.

This is assigned to a map in the [[Legacy:Level Properties|Level Properties]] window, under LevelInfo -> DefaultGameType.

The <tt>GameInfo</tt> for the current game can be retrieved from every actor in that game via <tt>Level.Game</tt>, but ''only'' on the server. <tt>GameInfo</tt> is not replicated to network clients; only [[Legacy:GameReplicationInfo (UT)|GameReplicationInfo (UT)]] is.

See [[Legacy:GameInfo|GameInfo]] for the UT200x version of this class.

==Properties==

===Globalconfig Properties===
; bool bMuteSpectators : Whether spectators are allowed to speak.
; bool bLowGore : Whether or not to reduce gore.
; bool bVeryLowGore : Greatly reduces gore.
; bool bNoCheating : Disallows cheating. Hehe.
; bool bAllowFOV : Allows FOV changes in net games
; bool bExternalBatcher :
; float AutoAim : How much autoaiming to do (1 = none, 0 = always). (cosine of max error to correct)
; float GameSpeed : Scale applied to game rate.
; int MaxSpectators : Maximum number of spectators.
; private string AdminPassword : Password to receive bAdmin privileges.
; private string GamePassword : Password to enter game.
; int MaxPlayers :
; string ServerLogName : Server Log
; bool bLocalLog :
; bool bWorldLog :
; bool bBatchLocal :
; int DemoBuild :
; int DemoHasTuts :
; string IPPolicies[50] :

===Config Properties===
; bool bNoMonsters : Whether monsters are allowed in this play mode.
; bool bHumansOnly : Whether non human player models are allowed.
; bool bCoopWeaponMode : Whether or not weapons stay when picked up.
; bool bClassicDeathmessages : Weapon deathmessages if false.

===Localized Properties===
; bool bAlternateMode :
; string SwitchLevelMessage :
; string DefaultPlayerName :
; string LeftMessage :
; string FailedSpawnMessage :
; string FailedPlaceMessage :
; string FailedTeamMessage :
; string NameChangedMessage :
; string EnteredMessage :
; string GameName :
; string MaxedOutMessage :
; string WrongPassword :
; string NeedPassword :
; string IPBanned :

===Other Properties===
; int ItemGoals, KillGoals, SecretGoals : Special game goals.
; byte Difficulty : In Unreal: 0=easy, 1=medium, 2=hard, 3=very hard. In UT: 0=Novice, 1=Average, 2=Experienced, 3=Skilled, 4=Adept, 5=Masterful, 6=Inhuman, 7=Godlike.
; bool bRestartLevel :
; bool bPauseable : Whether the level is pauseable.
; bool bCanChangeSkin : Allow player to change skins in game.
; bool bTeamGame : This is a teamgame.
; bool bDeathMatch : This game is some type of deathmatch (where players can respawn during gameplay)
; bool bGameEnded : set when game ends
; bool bOverTime :
; bool bCanViewOthers :
; float StartTime :
; class<[[Legacy:PlayerPawn|PlayerPawn]]> DefaultPlayerClass :
; class<[[Legacy:Weapon (UT)|Weapon (UT)]]> DefaultWeapon : Default weapon given to player at start.
; int NumSpectators : Current number of spectators.
; class<[[Legacy:ScoreBoard|ScoreBoard]]> ScoreBoardType : Type of scoreboard this game uses.
; class<[[Legacy:Menu|Menu]]> GameMenuType : Type of oldstyle game options menu to display.
; string BotMenuType : Type of bot menu to display.
; string RulesMenuType : Type of rules menu to display.
; string SettingsMenuType : Type of settings menu to display.
; string GameUMenuType : Type of Game dropdown to display.
; string MultiplayerUMenuType : Type of Multiplayer dropdown to display.
; string GameOptionsMenuType : Type of options dropdown to display.
; class<[[Legacy:HUD (UT)|HUD (UT)]]> HUDType : HUD class this game uses.
; class<[[Legacy:MapList|MapList]]> MapListType : Maplist this game uses.
; string MapPrefix : Prefix characters for names of maps for this game type.
; string BeaconName : Identifying string used for finding LAN servers.
; string SpecialDamageString :
; int SentText :
; int NumPlayers :
; int CurrentID :
; class<[[Legacy:LocalMessage (UT)|LocalMessage (UT)]]> DeathMessageClass :
; class<[[Legacy:LocalMessage (UT)|LocalMessage (UT)]]> DMMessageClass : A message class to be used for commonly used messages. For example, the [[Legacy:DeathMatchPlus|DeathMatchPlus]] gametype sets [[Legacy:DeathMatchMessage|DeathMatchMessage]] as the default, which contains messages for overtime, players leaving and joining the game, players changing names, and players switching teams.
; class<[[Legacy:Mutator|Mutator]]> MutatorClass : Class of this gametype's base mutator. (Default is Engine.[[Legacy:Mutator|Mutator]], [[Legacy:DeathMatchPlus|DeathMatchPlus]] uses Botpack.[[Legacy:DMMutator|DMMutator]].)
; [[Legacy:Mutator|Mutator]] BaseMutator :
; [[Legacy:Mutator|Mutator]] DamageMutator : [[Legacy:Linked List|Linked list]] of mutators which affect damage.
; [[Legacy:Mutator|Mutator]] MessageMutator : [[Legacy:Linked List|Linked list]] of mutators which get localized message queries.
; class<[[Legacy:ZoneInfo|ZoneInfo]]> WaterZoneType : Default waterzone entry and exit effects
; name DefaultPlayerState : What state a player should start in for this game type
; class<[[Legacy:GameReplicationInfo|GameReplicationInfo]]> GameReplicationInfoClass :
; [[Legacy:GameReplicationInfo|GameReplicationInfo]] GameReplicationInfo :
; [[Legacy:StatLog|StatLog]] LocalLog :
; [[Legacy:StatLog|StatLog]] WorldLog :
; bool bLoggingGame : Does this gametype log?
; string LocalLogFileName :
; string WorldLogFileName :
; class<[[Legacy:StatLog|StatLog]]> StatLogClass :
; string EnabledMutators : Server query info

==Methods ==
; AdminLogin ([[Legacy:PlayerPawn|PlayerPawn]] P, string Password) : This function will allow a player to log in as the administrator if the password entered is correct. The function also broadcasts a notification message to the other players.
; AdminLogout ([[Legacy:PlayerPawn|PlayerPawn]] P) : This function is called when a player leaves administrator mode. It ensures that the player is forced to "Walk", and kills them. There is code in there to preserve the players score when they die from logging out of admin mode but I'm sure it doesn't work in practice. – must check.
; InitLogging ( ) : Called from <tt>PostBeginPlay()</tt>. Logs more stuff than you can shake a big stick at. Calls functions on the WorldLog, Log, and LocalLog objects to do so.
; InitGameReplicationInfo ( ) : This function is responsible for placing the values of the attributes of the GameInfo class important to the client onto the [[Legacy:GameReplicationInfo|GameReplicationInfo]] object.
; string GetInfo ( ) : Returns the status of the World log.
; string GetRules ( ) : This function builds up a description of the server from the list of mutators currently in use, the type of server (Listen or otherwise), and whether there is a password on the server or not.
; int GetServerPort ( ) : This functon returns the port the server is runing on by interrogating the level URL.
; bool SetPause (bool bPause, [[Legacy:PlayerPawn|PlayerPawn]] P) : If the level can be paused then the player who paused the game is stored and the function returns ''true''. If the game is not pausable then the function will return ''false''.
; LogGameParameters ([[Legacy:StatLog|StatLog]] StatLog) : This function writes the general game parameters to the <tt>StatLog</tt>.
; SetGameSpeed (float T) : This function sets the game speed (but never below 0.1).
; bool IsRelevant ([[Legacy:Actor|Actor]] Other) : This function is called from any [[Legacy:Actor|Actor]]'s <tt>PreBeginPlay()</tt>. If this function returns ''true'' the actor continues to exist. If the function returns ''false'' the actor is removed from the game. This function calls the <tt>AlwaysKeep()</tt> and <tt>IsRelevant()</tt> functions on any mutators within the game prior to checking actor difficulty levels and "odds of appearing" values. The function also counts the number of remaining <tt>SecretGoals</tt>, <tt>ItemGoals</tt>, and <tt>KillGoals</tt> left within the level (also see [[Legacy:Creating Actors And Objects|Creating Actors And Objects]]).
; bool GrabOption (out string Options, out string Result) : Grabs the next left option from a string. ''Result'' contains the part between the first "?" and the next "?" (if exist). ''Result'' is removed then from ''Options''. If ''Options'' starts with "?", ''true'' is returned, otherwise ''false''.
; GetKeyValue (string Pair, out string Key, out string Value) : Break up a ''key=value'' pair into its key and value.
; bool HasOption (string Options, string InKey) : See if an option was specified in the options string.
; string ParseOption (string Options, string InKey) : Find the most left option of kind "''InKey''=Value" in ''Options'' and returns ''Value'' if ''InKey'' has been found, an empty string else. ''Options'' stays unchanged.
; ProcessServerTravel (string URL, bool bItems) : Called when a map changes. Is responsible for handling the transfer of players and their inventory as well as ensuring that all logging for the level just played is tidied up.
; bool AtCapacity (string Options) : This function returns ''true'' if the server has the maximum number of players allowed on it.
; bool CheckIPPolicy (string Address) : Returns ''true'' if the IP address of the client is allowed to connect to the server.
; int GetIntOption( string Options, string ParseString, int CurrentValue ) : Same as '''ParseOption''' but returns an Integer. If the key ''ParseString'' is not found, ''CurrentValue'' is returned.
; Logout ([[Legacy:Pawn (UT)|Pawn (UT)]] Exiting) : Logs the player out and tells the logging engine about it.
; AddDefaultInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn) : Add any default inventory to the player.
; NavigationPoint FindPlayerStart ([[Legacy:Pawn (UT)|Pawn (UT)]] Player, optional byte InTeam, optional string incomingName) : Locates the "best" player start for the player.
; bool RestartPlayer ([[Legacy:Pawn (UT)|Pawn (UT)]] aPlayer) : Restart a player after he has died. This function adds the default inventory by calling <tt>AddDefaultInventory()</tt>, finds a start location by calling <tt>FindPlayerStart()</tt>. Once this has been acomplished, sets the player's stats back to defaults.
; StartPlayer ([[Legacy:PlayerPawn|PlayerPawn]] Other) : Start a player. Finish me
; Killed ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other, name damageType) : Called when someone gets killed. This function broadcasts the death message, logs the event, and calls the <tt>ScoreKill()</tt> function.
; BroadcastRegularDeathMessage ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other, name damageType) : Calls on to <tt>BroadcastLocalizedMessage()</tt>.
; ScoreKill ([[Legacy:Pawn (UT)|Pawn (UT)]] Killer, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) : Increases the Killer's killCount and score by 1 unless it was a suicide - in which case the killed pawn loses a point.
; string KillMessage (name damageType, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) [static] : Returns " died." as a default catch all death message.
; bool CanSpectate ([[Legacy:Pawn (UT)|Pawn (UT)]] Viewer, [[Legacy:Actor|Actor]] ViewTarget) : Returns whether ''Viewer'' is allowed to use ''ViewTarget'' as its point of view. GameInfo's return value is unconditionally ''true''.
; RegisterDamageMutator ([[Legacy:Mutator|Mutator]] M) : Adds a damage mutator at the front of the list of damage mutators.
; RegisterMessageMutator ([[Legacy:Mutator|Mutator]] M) : Adds a message mutator at the front of the list of message mutators.
; int ReduceDamage (int Damage, name DamageType, [[Legacy:Pawn (UT)|Pawn (UT)]] injured, [[Legacy:Pawn (UT)|Pawn (UT)]] instigatedBy) : This function returns a damage of 0 if the injured [[Legacy:Pawn (UT)|Pawn (UT)]] is in a zone that has it's <tt>bNeutralZone</tt> property set to ''true''. Otherwise the original damage is returned.
; bool ShouldRespawn ([[Legacy:Actor|Actor]] Other) : Returns whether an actor item should respawn. In death matches this function should return ''true'' for weapon and item pickups.
; bool PickupQuery ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, [[Legacy:Inventory (UT)|Inventory (UT)]] Item) : Called when pawn has a chance to pick Item up (i.e. when the pawn touches a weapon or item pickup). Should return ''true'' if it is allowed to pick it up, ''false'' if not.
; DiscardInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] Other) : Discard a player's inventory after he dies.
; float PlayerJumpZScaling ( ) : Returns 1.0, but could be overidden for "low grav" game types.
; ChangeName ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, coerce string S, bool bNameChange) : Attempt to change a players name.
; bool ChangeTeam ([[Legacy:Pawn (UT)|Pawn (UT)]] Other, int N) : Return whether a player can change teams or not.
; float PlaySpawnEffect ([[Legacy:Inventory (UT)|Inventory (UT)]] Inv) : Play an inventory respawn effect.
; string PlayerKillMessage (name damageType, [[Legacy:PlayerReplicationInfo|PlayerReplicationInfo]] Other) [static] : returns " was killed by ".
; string CreatureKillMessage (name damageType, [[Legacy:Pawn (UT)|Pawn (UT)]] Other) [static] : returns "was killed by a "
; SendPlayer ([[Legacy:PlayerPawn|PlayerPawn]] aPlayer, string URL) : Send the player specified to the URL passed to the function.
; RestartGame ( ) : Called to restart the current game.
; bool AllowsBroadcast ([[Legacy:Actor|Actor]] broadcaster, int Len) : Returns ''true'' if the [[Legacy:Actor|Actor]] passed to the function is allowed to broadcast a message.
; EndGame (string Reason) : Called at the end of the game. If first calls <tt>BaseMutator.HandleEndGame()</tt> and <tt>SetEndCams()</tt> and if both returns ''false'' game is not ended but <tt>bOverTime</tt> set to ''true''. Otherwise <tt>bGameEnded</tt> is set to ''true'', the event 'EndGame' is risen and game logging is closed down.
; bool SetEndCams (string Reason) : Puts all player pawns into a ''GameEnded'' state and calls the <tt>ClientGameEnded()</tt> function on them. The function returns ''true''.
; ResetGame ( ) [static] : GameInfo's <tt>ResetGame( )</tt> does nothing. In Game type ''Assault'' it is overridden and some default values are reset and saved there.
; bool AddBot ( ) : GameInfo's <tt>AddBot( )</tt> does nothing. It is overwitten in derivied game types, for example in ''DeathMatchPlus''.
; bool ForceAddBot ( ) : GameInfo's <tt>ForceAddBot( )</tt> does nothing. It is overridden in ''DeathMatchPlus''.
; PlayTeleportEffect ([[Legacy:Actor|Actor]] Incoming, bool bOut, bool bSound) : It is intended to play a teleporting special effect, but GameInfo's <tt>PlayTeleportEffect( )</tt> does nothing. Overridden for example in ''DeathMatchPlus''.

===Native Functions ===
; string GetNetworkNumber() : (unknown)
; string ParseKillMessage (string KillerName, string VictimName, string WeaponName, string DeathMessage) [static] : Parses the kill message. Replaces the first occurances of <tt>%k</tt>, <tt>%o</tt> and <tt>%w</tt> with <tt>KillerName</tt>, <tt>VictimName</tt> and <tt>WeaponName</tt> respectively (also see [[Legacy:Message Placeholder|Message Placeholder]]).

===Events ===
; GameEnding ( ) : This functon is called when a game is shut down. It halts any world logging and local logging.
; DetailChange ( ) : This function is called whenever the client changes their level of detail (high to low, or low to high). Apart from re-linking all of the zones to a SkyBox, any actors with their <tt>bHighDetailMode</tt> property set to ''true'' will be destroyed on entry to a "low detail" mode.
; InitGame (string Options, out string Error) : This function is called before the [[Legacy:Actor|Actor]]s <tt>PreBeginPlay()</tt> function. It sets up some of the game options and spawns the [[BaseMutator]].
; string GetBeaconText ( ) : Returns ''Level.ComputerName'', the length truncated ''Level.Title'', the ''BeaconName'' and the number of players and ''MaxPlayers''. Used by <tt>UdpBeacon.BroadcastBeacon()</tt>.
; PreLogin (string Options, string Address, out string Error, out string FailCode) : Accepts or rejects a player based upon any game password validation, IP bans, and current server capacity.
; [[Legacy:PlayerPawn|PlayerPawn]] Login (string Portal, string Options, out string Error, class<[[Legacy:PlayerPawn|PlayerPawn]]> SpawnClass) : Log a player in. Fails login if you set the Error string. <tt>PreLogin()</tt> is called before <tt>Login()</tt>, but significant game time may pass before <tt>Login()</tt> is called, especially if content is downloaded.
; PostLogin ([[Legacy:PlayerPawn|PlayerPawn]] NewPlayer) : Called after a successful login. This is the first place it is safe to call replicated functions on the PlayerPawn. finish me
; AcceptInventory ([[Legacy:Pawn (UT)|Pawn (UT)]] PlayerPawn) : Called when new inventory is accepted. Calls the function <tt>AddDefaultInventory()</tt>.
; ScoreEvent (name EventName, [[Legacy:Actor|Actor]] EventActor, [[Legacy:Pawn (UT)|Pawn (UT)]] InstigatedBy) : Intended to award a score to an actor. GameInfo's <tt>ScoreEvent()</tt> does nothing.

==Known subclasses ==
* [[Legacy:UnrealGameInfo|UnrealGameInfo]]
* [[Legacy:TournamentGameInfo|TournamentGameInfo]]

==Comments ==

We could do with a nice time diagram showing when all of the different functions and events (including those on the mutators) get called.

==Related Topics ==

See [[Legacy:Function Syntax|Function Syntax]] and [[Legacy:Variable Syntax|Variable Syntax]] for additional background information.

----

[[:Category:Legacy Class (UT)]]

----

'''Fearless''': Hmmm, some interesting information here even if it's basic. I'd really like to do a mutator that changes gamespeed without the intervention of an admin. I have also a little question concerning the adminlogout command. It says here that the player is killed when the command is invoked. This does happen on our Linux 4.40 server but this doesn't happen on a server you're hosting yourself. Does anyone have any idea why this is :P ?

'''NogginBasher''': You can do that using a combination of x3dfxMapVote and IdeFiX's ServerMode. In ServerMode.ini you need something like: "Commands[11]=SET Engine.GameInfo GameSpeed 1.25". I'm currently testing: "Commands[12]=SET Botpack.DeathMatchPlus bHardcoreMode True"
[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:View Fog

2016-12-25T10:04:05Z

SeriousBarbie: +See Also

'''View Fog''' is a simple method of adding [[Legacy:Fog|fog]] to a map or an area in a map. It works by simply tinting the rendered scene by a specified amount. View Fog is sometimes also referred to as "fake fog". It uses practically no rendering resources, so it is very cheap resource-wise, but it is not that realistic. Often an underwater area will have a blueish view fog.

==Setting Up View Fog in Unreal Tournament==

In [[Legacy:Unreal Tournament|Unreal Tournament]], view fog is specific to the zone containing the camera. It is specified by the ''ViewFlash'' and ''ViewFog'' variables in the zone's [[Legacy:ZoneInfo (UT)|ZoneInfo]].ZoneLight. Here's a sample configuration:

{|

|-
|ViewFlash X
|-0.5
|-
|ViewFlash Y
|-0.5
|-
|ViewFlash Z
|-0.5
|-
|ViewFog X
|0.5
|-
|ViewFog Y
|0.5
|-
|ViewFog Z
|0.5
|}

==Setting Up View Fog in UT2003==

View Fog does not appear to work properly in [[Legacy:UT2003|UT2003]], however, the variables for it are still present so theoretically it may still work on some graphics hardware. View Fog is controlled by [[Legacy:PhysicsVolume|PhysicsVolume]]s in UT2003. Specifically, PhysicsVolumes are used. To set up View Fog, simply set the PhysicsVolume->ViewFog property to whatever color you want the screen to be tinted.

'''Tarquin:''' so does it work or not?

'''SuperApe:''' I'm wondering if the author meant to say ViewFlash doesn't work in UT200x, not ViewFog. Distance fog seems to work fine. But the issue is confused by the properties ViewFog and FlashFog in [[Legacy:DamageType|DamageType]]. I found this page through a search for that stuff.

== See Also ==
* [[Legacy: Fog]]

Legacy:Global Function (UT)

2016-11-23T23:14:25Z

SeriousBarbie: +"is equal to or"

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Object (UT)|Object (UT)]] (Methods)}}

The functions listed here are globally available in all classes. Due to [[Legacy:UnrealScript|UnrealScript]]'s strict object-oriented approach, they're actually methods of the [[Legacy:Object (UT)|Object (UT)]] class.

Almost all of these functions are declared as native and final (see [[Legacy:Class Syntax|class syntax]]) and most of them are also [[Legacy:Static Function|static function]]s.

See [[Legacy:Vector|vector]] and [[Legacy:Rotator|rotator]] for functions on those variable types.

See [[Legacy:Global Function|Global Function]] for global UT2003 functions.

===Integer Functions ===
; int Rand (int Max) [static] : Returns a random number ranging from 0 to Max-1.
; int Min (int A, int B) [static] : Returns the lower of the two values.
; int Max (int A, int B) [static] : Returns the higher of the two values.
; int Clamp (int V, int A, int B) [static] : If V is smaller than A, A is returned. If V is larger than B, B is returned. In any other case V is returned.

===Float Functions ===
; float Abs (float A) [static] : Returns the absolute value of A, usually written |A|. Eg: Abs(5) == Abs(-5) == 5.
; float Sin (float A) [static] : Returns sine( A )
; float Cos (float A) [static] : Returns cosine( A )
; float Tan (float A) [static] : Returns tan( A )
; float Atan (float A) [static] : Inverse tangent. Returns tan-1-(A). Other inverse trig functions are not included in [[Legacy:UT|UT]]'s UnrealScript. (see [[Legacy:Useful Maths Functions|Useful Maths Functions]])
; float Exp (float A) [static] : Returns eA
; float Loge (float A) [static] : Returns log(A), the natural logarithm.
; float Sqrt (float A) [static] : Returns the square root of A.
; float Square (float A) [static] : Returns A2.
; float FRand ( ) : Returns a random number between 0 and 1.
; float FMin (float A, float B) [static] : Returns the lower of the two values.
; float FMax (float A, float B) [static] : Returns the higher of the two values.
; float FClamp (float V, float A, float B) [static] : If V is smaller than A, A is returned. If V is larger than B, B is returned. In any other case V is returned.
; float Lerp (float Alpha, float A, float B) [static] : "Returns the linear interpolation between A and B." The return value is calculated through something like this: <tt>(B - A) * Alpha + A</tt>
; float Smerp (float Alpha, float A, float B) [static] : Returns an Alpha-smooth nonlinear interpolation between A and B. The return value seems to be calculated through something like this: <tt>(-2 * (B - A) * Alpha ** 3) + (3 * (B - A) * Alpha ** 2) + A</tt>
;[[Image:Legacy_interpolation-smerp.gif|Legacy_interpolation-smerp.gif]]
; float RandRange (float Min, float Max) : Returns a random number between Min and Max. This function is not static.

===String Functions ===
; int Len (coerce string S) [static] : Returns the length of the string, i.e. the number of characters in it.
; int InStr (coerce string haystack, coerce string needle) [static] : If the string <tt>needle</tt> is found inside <tt>haystack</tt>, the number of characters in <tt>haystack</tt> ''before'' the first occurance of <tt>needle</tt> is returned. That is, if the <tt>needle</tt> is found right at the beginning of <tt>haystack</tt>, 0 is returned. If <tt>haystack</tt> doesn't contain <tt>needle</tt>, InStr returns -1.
; string Mid (coerce string S, int skip, optional int num) [static] : Returns a substring of <tt>S</tt>, skipping <tt>skip</tt> characters and returning the next <tt>num</tt> characters or all remaining if the third parameter is left out. Mid("hello", 0, 2) returns "he", Mid("hello", 1) returns "ello", i.e. all but the first character.
; string Left (coerce string S, int num) [static] : Returns the <tt>num</tt> leftmost characters of <tt>S</tt> or all of them if <tt>S</tt> contains less than <tt>num</tt> characters.
; string Right (coerce string S, int num) [static] : Returns the <tt>num</tt> rightmost characters of <tt>S</tt> or all of them if <tt>S</tt> contains less than <tt>num</tt> characters.
; string Caps (coerce string S) [static] : Returns <tt>S</tt> converted to uppercase.
; string Chr (int i) [static] : Returns the character matchin the given ASCII code.
; int Asc (string S) [static] : Returns the ASCII code of the first character in <tt>S</tt>.

===General Functions ===

====Logging ====
; Log (coerce string S, optional name Tag) [static] : Writes a line to the log file. The line begins with the Tag or "ScriptLog:" if Tag was not specified, followed by the log string. The tags 'Error' and 'Warning' (and probably others, too) have a special meaning in [[Legacy:Commandlet|Commandlet]]s.
; Warn (coerce string S) [static] : Same like <tt>Log</tt>, but the line starts with "ScriptWarning:" and contains information about the object, state and function that called <tt>Warn</tt>.
; string Localize (string SectionName, string KeyName, string PackageName) [static] : Returns the string found in ''PackageName''.int in the [''SectionName''] section. Logs an error if no localization for the specified string is found.

====State-Related ====
; GotoState (optional name NewState, optional name Label) : Switches to a new state. State code execution begins at the specified label or at "Begin:" if <tt>Label</tt> is not specified. Before the state is changed the old state's <tt>EndState</tt> function is called. After the state changed <tt>BeginState</tt> of the new state is called.
; bool IsInState (name TestState) : Returns whether the object's current state is the one specified.
; name GetStateName ( ) : Returns the object's current state name.
; BeginState ( ) [not native, not final] : This event is executed during GotoState right after the object switched to the new state. This function can be overridden in any state of any class.
; EndState ( ) [not native, not final] : This event is executed during GotoState right before the object switches to the new state. This function can be overridden in any state of any class.

====Class Hierarchy ====
; bool ClassIsChildOf (class TestClass, class ParentClass) [static] : Returns whether <tt>TestClass</tt> is equal to or a subclass of <tt>Parentclass</tt>.
; bool IsA (name ClassName) : Returns whether the object's class is the specified class or a subclass. This function doesn't need a reference to the desired class, but just the class's name.

====Enabling / Disabling Functions ====
; Enable (name ProbeFunc) : Enables a [[Legacy:Probe Function|probe function]].
; Disable (name ProbeFunc) : Disables a [[Legacy:Probe Function|probe function]].

====Objects / Properties ====
; string GetPropertyText (string PropName) : Returns the value of the specified property [[Legacy:Typecasting|typecasted]] to string. This is useful when you don't want any dependencies to the package of an object, but still need to access its properties. Usage: <tt>aString = anObject.GetPropertyText("''PropertyName''");</tt>
; SetPropertyText (string PropName, string PropValue) : Assigns a value to the specified property of an object. Only use this for properties that can be [[Legacy:Typecasting|typecasted]] from string. Usage: <tt>anObject.SetPropertyText("''PropertyName''", "''new value''");</tt>
; name GetEnum (Object E, int i) [static] : Returns the i-th element of the given enumeration, as in <code>GetEnum(enum'MyEnum', 2)</code> or an empty name of the specified index exceeds the number of elements in the enumeration.
; [[Legacy:Object (UT)|Object (UT)]] DynamicLoadObject (string ObjectName, Class ObjectClass, optional bool MayFail) [static] : Loads and returns the specified object. If <tt>bMayFail</tt> is true no error will be logged.
; SaveConfig ( ) : Saves the current values of config and globalconfig variables of this object to the ini file and sets them as default values for the object's class.
; StaticSaveConfig ( ) [static] : Saves the default values of config and globalconfig variables of this object's class to the ini file.
; ResetConfig ( ) [static] : Resets the config and globalconfig variables of this object's class to the values stored in Default.ini or DefUser.ini.

==Related Topics ==
* [[Legacy:UnrealScript|UnrealScript]]
** [[Legacy:Class Syntax|Class Syntax]]
** [[Legacy:Function Syntax|Function Syntax]]
** [[Legacy:Operators|Operators]]
** [[Legacy:Object (UT)|Object class]]

User:SeriousBarbie

2016-11-17T18:28:05Z

SeriousBarbie: +Scripting helper functions

Just some notes here:
* <nowiki>{{disambig}}</nowiki> for multiple meanings
* Scripting helper functions: [[Legacy:WUtils]]

Talk:DamageType

2016-11-13T13:36:01Z

SeriousBarbie: legacy and non-legacy

Why are you people so keen on referencing legacy pages from the non-legacy part of the wiki? —[[User:Wormbo|Wormbo]] 00:23, 11 November 2016 (EST)
:Is there any definition available here what is classified as "legacy" and what as "non-legacy"? I didn't find such. I guess that everything related to current Unreal engine is "non-legacy", everything to previous versions "legacy". But that would be a bad classification IMO. --[[User:SeriousBarbie|SeriousBarbie]] ([[User talk:SeriousBarbie|talk]]) 10:08, 11 November 2016 (EST)
::It's right in the page name, the "Legacy" part before the colon. Background is that the old UnrealWiki (before the switch to MediaWiki) had a very wonky copyright statement. —[[User:Wormbo|Wormbo]] 11:25, 11 November 2016 (EST)
:::Oh, I thought it was an indicator for "out of date". I must say that I'm really confused about the structure and different copyrights here (it has taken more that two years or me to accidentally find [[Unreal Wiki:Copyrights]]...) Isn't it possible to get rid of these different copyrights? A note to the copyright holder: on [[Legacy:Project_Copyright]] I found the statement ''The collection and structure of UnrealWiki are copyright UnrealWiki''. But I did not find any information what ''UnrealWiki'' is - a foundation, person or company?
:::Back to concrete: Instead of editing "legacy" pages: what should I do if I want to add some infos on a matter that is classified as "legacy"? (Let's take [https://wiki.beyondunreal.com/Legacy:LevelInfo_%28UT%29?curid=1704&diff=46379&oldid=46169 this change] as an example.)
:::And if I create complete new content ("non-legacy"), why is it unwanted to link to "legacy" pages there? --[[User:SeriousBarbie|SeriousBarbie]] ([[User talk:SeriousBarbie|talk]]) 08:36, 13 November 2016 (EST)

Talk:DamageType

2016-11-11T15:08:56Z

SeriousBarbie: legacy and non-legacy

DamageType

2016-11-11T03:10:23Z

SeriousBarbie: moved disambig to top - seems default here

{{disambig}}
'''DamageType''' refers to:
* [[Legacy:DamageType|UT2003: DamageType]]
* [[Legacy:DamageType_%28UT%29|UT: DamageType]]

Legacy:FlockPawn

2016-11-11T03:09:06Z

SeriousBarbie: +immune against corroded

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Pawn (UT)|Pawn (UT)]] >> FlockPawn}}

These are quite easy, so i dont know why no-one did them before:

The flockpawns are:
*Bird1
*BiterFish
*Bloblet
*Horsefly
*NaliRabbit

All of these (except the rabbit and the bird) need a [[Legacy:FlockMasterPawn|FlockMasterPawn]] to work.

Heres how to use them all:

===The Amoeba (Bloblet)===

This is the most complicated flockpawn, and has only ever been used properly once (I think).

To work it, place several Bloblet actors in one area, then place the ParentBlob pawn (the controller of the bloblets) in the middle of the group. Open the properties of all the bloblets and the parentblob and change them to the same tag; add several triggers around your map and set the event to the amoeba's tag (to keep it constantly aggressive) and there you have a working amoeba!

Notes:
* I don't know if this works online, but it does offline.
* Bloblets are immune against [[DamageType]] ''corroded''.

===Biter Fish===

These are easier than bloblets, you just simply put the [[Legacy:FlockMasterPawn|FlockMasterPawn]] in the level, then change the properties to control the number of fish, the fact that they are violent, and how far the fish swim from the master pawn. Horseflies work in the same way

===Birds and Nali Rabbits===

These are the easiest to work. Just place them in the level and watch them go! no master pawn needed

'''Ghost:''' With regards to the FlockMasterPawn Bird1, is it possible to export the Bird1 animation along with it's script sequence from UT over to UT2003?

'''Wormbo:''' You might be able to export it with the [[Legacy:WOTgreal|WOTgreal]] exporter or with the [[Legacy:UT Package Tool|UT Package Tool]]. To import it just use the [[Legacy:Exec Directive|exec directive]]s of the Bird1 class.

'''Ghost:''' That worked, thanks.

==Related Topics ==
* [[Legacy:Artificial Intelligence|Artificial Intelligence]]

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

DamageType

2016-11-11T03:07:56Z

SeriousBarbie: disambig: DamageType

'''DamageType''' refers to:
* [[Legacy:DamageType|UT2003: DamageType]]
* [[Legacy:DamageType_%28UT%29|UT: DamageType]]

{{disambig}}

Legacy:Mover (UT)

2016-11-10T00:28:21Z

SeriousBarbie: Hint to bDynamicLightMover and semi-solid brushes

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Brush|Brush]] >> Mover (Package: Engine)}}

(see [[Legacy:Mover|Mover]] for the UT2003 version of this class)

In UT '''Movers''' are brushes that move. They are not part of the [[Legacy:BSP|BSP]], but look as if they are to the player. Use them to create doors, elevators and other parts of dynamic level geometry. This page describes the class in detail.

Terminology: A mover is said to "open" when it moves from key 0 to the last defined key (''NumKeys-1'' for the technically-minded). Movement in the opposite direction is called "closing". Some subclasses of mover have the ability to open partially.

==Properties==
===Events Group===
;name Event: This event is fired when the Mover has finished opening (reached last position of ''KeyNum'') and before the ''StayOpenTime'' begins to run. [[Legacy:Types Of Mover|Other Mover types]] may implement other behaviour.
;name Tag:(as usual)

===Mover Group===
; bool bDamageTriggered : The mover is triggered by taking damage. Use for doors that open when you shoot then, for example.
; bool bDynamicLightMover : Setting this to True will cause the mover to change the way it is lit as it moves. This is very useful when a mover is going between areas with different brightnesses or colors of light. Note that BrushRayTraceKey is unused if the mover is dynamically lit. The process isn't perfect by any means, and often has dirty shadows and flickering between different lightings on the brush. However, it does eliminate the annoying black patches on the undersides of lifts and the sides of doors. In addition this takes quite a bit more CPU power than normal. Use this only in areas where it is needed to make the mover look decent and processing power can be spared. If the mover's surface stays completely dark, make sure that it does not share any surface with [[Legacy:Semisolid|semi-solid]] brushes.
; byte BrushRaytraceKey (const) : This should be set to the number of a keyframe. When the map's lighting is rebuilt, the polys of the mover will always be lit as if it is in this position. (Naturally, this property is irrelevant if you have bDynamicLightMover = True.)
; bool bSlave : This mover is a slave. It will follow another mover. See [[Legacy:Compound Movers|Compound Movers]].
; bool bTriggerOnceOnly : Go dormant after first trigger. Note that this doesn't work for all states (see ''Mover States'' below).
; name BumpEvent : The name of an [[Legacy:Event|event]] to fire when any something bumps this mover. This allows you to have movers that can be either triggered or bumped: you have the BumpEvent trigger the mover's own Tag.
; EBumpType BumpType : Determines what sort of things are counted as bumping this mover. Other things that bump it will be ignored.
; bool bUseTriggered : This mover will be triggered by player grab.
; float DamageThreshold : Minimum damage to trigger. Works with bDamageTriggered.
; float DelayTime : Delay before starting to open.
; int EncroachDamage : How much to damage encroached actors.
; byte KeyNum : The number of the key that the mover is curently set to. Using the [[Legacy:Brush Context Menu|Brush Context Menu]] -> Mover -> Key command is the same as changing this value. See [[Legacy:Keyframe|Keyframe]] for more on this.
; EMoverEncroachType MoverEncroachType : Tells the mover what to do when it hits an actor while trying to move. For example, when a lift returns to the low position and hits a player's head. (see ''EMoverEncroachType'' enum below)
; EMoverGlideType MoverGlideType : How the mover moves from one position to another. (see ''EMoverGlideType'' enum below)
; float MoveTime : Time to spend moving between keyframes.
; byte NumKeys (const) : This is the number of different positions (known as ''keys'') that the mover has. The maximum possible value seems to be 64.
; float OtherTime : TriggerPound stay-open time.
; name PlayerBumpEvent : Optional event to cause when the player bumps the mover.
; name ReturnGroup : {{Legacy:Mover/ReturnGroup}} If none is given, Mover's BeginPlay() code sets it to the value of ''Tag''. This may lead to undesired behaviour, so using an unique value for ReturnGroup seems to be the best solution if no other Movers depend on this Mover.
; float StayOpenTime : How long to remain open before closing.
; byte WorldRaytraceKey (const) : Set this to the number of the key you want the mover to affect the world at. Basically, whatever you set this to is where the mover will block light. A neat trick you can do with this property is to set it to an unused key which you have positioned somewhere outside your map. That way the mover will not cast a shadow at all. This can alleviate the annoying problem of black patches underneath movers.

===MoverSounds Group ===

The properties in this section set the sounds played by the mover as it travels.
; Sound ClosedSound : When finish closing.
; Sound ClosingSound : When start closing.
; Sound MoveAmbientSound : Optional ambient sound when moving.
; Sound OpenedSound : When finished opening.
; Sound OpeningSound : When start opening.

The sounds in UT packages like DoorsMod are designed with this system in mind, and are usually found in sets of 3, eg "md2start", "md2loop", "md2end". Use start sounds with Opening, end sounds with Opened and loop with ambient.

Only MoveAmbientSound is affected by the value of Sounds -> SoundVolume. The others play at full volume. (Some scripting would probably fix this for a custom class, since the Mover calls PlaySound, and this has an optional volume parameter.)

===UnrealScript-Only Properties===
; byte PrevKeyNum : Previous keyframe.
; [[Legacy:Actor (UT)|Actor (UT)]] SavedTrigger : Who we were triggered by.
; int numTriggerEvents : Number of times triggered (count down to untrigger)
; Mover Leader
; Mover Follower : For having multiple movers return together. (see [[Legacy:Compound Movers|Compound Movers]])
; vector KeyPos[8] :
; rotator KeyRot[8] :
; vector BasePos, OldPos, OldPrePivot, SavedPos :
; rotator BaseRot, OldRot, SavedRot :
; [[Legacy:NavigationPoint (UT)|NavigationPoint (UT)]] myMarker :
; [[Legacy:Actor (UT)|Actor (UT)]] TriggerActor :
; [[Legacy:Actor (UT)|Actor (UT)]] TriggerActor2 :
; [[Legacy:Pawn (UT)|Pawn (UT)]] WaitingPawn :
; bool bOpening, bDelaying, bClientPause :
; bool bPlayerOnly :
; [[Legacy:Trigger|Trigger]] RecommendedTrigger :
; vector SimOldPos :
; int SimOldRotPitch, SimOldRotYaw, SimOldRotRoll :
; vector SimInterpolate :
; vector RealPosition :
; rotator RealRotation :
; int ClientUpdate :

==Enums ==

===EMoverEncroachType ===
; ME_StopWhenEncroach : Stop when we hit an actor.
; ME_ReturnWhenEncroach : Return to previous position when we hit an actor.
; ME_CrushWhenEncroach : Crush the poor helpless actor.
; ME_IgnoreWhenEncroach : Ignore encroached actors.

===EMoverGlideType ===
; MV_MoveByTime : Move linearly.
; MV_GlideByTime : Move with smooth acceleration.

===EBumpType ===
; BT_PlayerBump : Can only be bumped by player.
; BT_PawnBump : Can be bumped by any pawn.
; BT_AnyBump : Cany be bumped by any solid actor.

==States==

The mover states, set in the [[Legacy:InitialState|InitialState]] property determine:
* how the mover is activated
* how it behaves once it has been activated

Note that other settings affect activation behavior too:
* the BumpType property affects ''who'' can activate it
* bDamageTriggered .....
* bUseTriggered ....

The "OpenTimed" states open the mover (from key 0 to the last key), wait then close and sleep again. Only the states with "Trigger" in the name respond to triggering.

;None: The mover will not move through its keys, unless it is a slave.

;BumpButton:
This is very similar to BumpOpenTimed, but designed to be used for a button which controls another mover which is set to TriggerOpenTimed (a door, for example).

Use the button mover's '''BumpEvent''' property to tie it to the door mover's Events -> Tag. When the button is bumped, it moves and so does the door. The button is then frozen, and it will only return when the door has successfully closed. This is pretty much just a nice cosmetic touch: the button won't return until it can be used again.

In brief:

* The button mover's StayOpenTime is ignored.
* If the door is prevented from closing (by a player, say), the button will not return
* Once the door mover has finished closing, the button mover is closed.

;BumpOpenTimed: The mover reacts to being touched. Set '''BumpType''' to determine what counts as touching it. Used for buttons (though see BumpButton for special cases). Can be used for doors, although TriggerControl is better.

;StandOpenTimed: The mover reacts when the engine detects a player has stood on it. Used for lifts.

;TriggerControl:
The mover opens while the trigger is active, and closes when unTriggered – ie if set up with a simple Trigger actor, as soon as the player steps out from the Trigger's radius the mover will start closing again.

Example: the door to the redeemer area in UT's DM-StalwartXL and CTF-Gauntlet. (note to anyone reading this: the [[Legacy:Event|Event]] page needs to explain that events can last for a duration, as in this case – there's an UnTrigger function too when a player steps out of a Trigger actor's radius.)

;TriggerOpenTimed: When triggered, the mover opens fully, waits and closes again. For related topics on triggering see the links section below.

;TriggerPound:
Similar to TriggerControl, but used for movers that open and close continuously. As soon as the corresponding trigger is activated, a mover using this state will begin the following cycle:

# Opens as usual, with its speed determined by the MoveTime property.
# Pauses for a time equal to the OtherTime property.
# Closes as usual, with its speed determined by the MoveTime property.
# Pauses for a time equal to the StayOpenTime property.

The mover loops through these actions until whatever activated the trigger leaves the trigger's collision area. When this happens, the mover immediately closes and remains at rest until triggered again.

;TriggerToggle: The mover will open when triggered and stop at the open position (the last keyframe). The next time it is triggered, it will close, and so on. Note that bTriggerOnceOnly has no effect in this state.

==Discussion==

'''Xian:''' while trying to see how I can misuse brushes in a better and more efficient way since I don't like the way Epic coded UT as a whole, I found this code in Engine.Mover.FindTriggerActor():

<uscript>
ForEach AllActors(class 'Actor', A)
if ( (A.Event == Tag) && (A.IsA('Trigger') || A.IsA('Mover')) )
{
if ( A.IsA('Counter') || A.IsA('Pawn') )
{
bPlayerOnly = true;
return; //FIXME - handle counters
}
[...]
}
</uscript>

How can a Trigger/Mover be a Pawn ? This seems like a nice logical error. Although the consequences may not be huge (since altogether the main triggering mechanism is done by movers/trigger classes), I just don't see how they could miss this... although it is trivial, check the next part:

<uscript>
bPlayerOnly = ( TriggerActor.IsA('Trigger') && (Trigger(TriggerActor).TriggerType == TT_PlayerProximity) );
if ( bPlayerOnly && ( TriggerActor2 != None) )
{
bPlayerOnly = ( TriggerActor2.IsA('Trigger') && (Trigger(TriggerActor).TriggerType == TT_PlayerProximity) );
if ( !bPlayerOnly )
{
A = TriggerActor;
TriggerActor = TriggerActor2;
TriggerActor2 = A;
}
}
</uscript>

My guess is the correct version is:

<uscript>
bPlayerOnly = ( TriggerActor.IsA('Trigger') && (Trigger(TriggerActor).TriggerType == TT_PlayerProximity) );
if ( bPlayerOnly && ( TriggerActor2 != None) )
{
// Xian correction: TriggerActor to TriggerActor2 :)
bPlayerOnly = ( TriggerActor2.IsA('Trigger') && (Trigger(TriggerActor2).TriggerType == TT_PlayerProximity) );
if ( !bPlayerOnly )
{
A = TriggerActor;
TriggerActor = TriggerActor2;
TriggerActor2 = A;
}
}
</uscript>

Again the code as a whole works, but let's face it, the rule of ''ntars'' should NOT apply here and this SHOULD be fixed imo. Perhaps people who wish to take advantage of custom Mover classes which are dependant on Triggers and TriggerActor(2) pointers should rewrite this function to fix it accordingly. Any thoughts ?

'''Graphik:''' I understand the trivial bit, but unfortunately not the useful part. I mean, I'm assuming there is one.

'''Xian:''' In my opinon, the code needs a lot of optimization and checks (for example in most parts it does iterations to all Actors with their Event matching the current Tag, while proper way of doing it, is to check if the Actor has an Event set, but most importantly to not iterate at all if there is no Tag set; true it does it only in PBP, but still). This was just a code-related discussion, and I assumed coders that would create custom Movers for UT would find this interesting. If you want a useful side of it, let me put it this way: assuming I am right (and to me it looks like I am), I have yet to see a correction of logical errors which is not useful :)

'''Graphik:''' OK cool.

'''Xian:''' ok so an optimized version imo:

<uscript>
function FindTriggerActor()
{
local Actor A;

TriggerActor = None;
TriggerActor2 = None;

// Xian: if there is no tag at all, why bother ?
if (Tag == '')
return;

foreach AllActors(class 'Actor', A)
if ((A.Event != '') && (A.Event == Tag) && (A.IsA('Trigger') || A.IsA('Mover')) )
{
if ( A.IsA('Counter') )
{
bPlayerOnly = true;
return; //FIXME - handle counters
}
if (TriggerActor == None)
TriggerActor = A;
else if ( TriggerActor2 == None )
TriggerActor2 = A;
}

if ( TriggerActor == None )
{
bPlayerOnly = (BumpType == BT_PlayerBump);
return;
}

bPlayerOnly = ( TriggerActor.IsA('Trigger') && (Trigger(TriggerActor).TriggerType == TT_PlayerProximity) );
if ( bPlayerOnly && ( TriggerActor2 != None) )
{
// Xian: fixed TriggerActor to TriggerActor2
bPlayerOnly = ( TriggerActor2.IsA('Trigger') && (Trigger(TriggerActor2).TriggerType == TT_PlayerProximity) );
if ( !bPlayerOnly )
{
A = TriggerActor;
TriggerActor = TriggerActor2;
TriggerActor2 = A;
}
}
}
</uscript>

<uscript>
function PostBeginPlay()
{
local mover M;

//brushes can't be deleted, so if not relevant, make it invisible and non-colliding
if ( !Level.Game.IsRelevant(self) )
{
SetCollision(false, false, false);
bCollideWorld = False; // Xian: :)
SetLocation(Location + vect(0,0,20000)); // temp since still in bsp
bHidden = true;
}
else
{
FindTriggerActor();
// Initialize all slaves.
if( !bSlave && (Tag != '')) ) // Xian: tag check
{
foreach AllActors( class 'Mover', M, Tag )
{
if( M.bSlave )
{
M.GotoState('');
M.SetBase( Self );
}
}
}
if ( Leader == None )
{
Leader = self;

if (ReturnGroup != '') // Xian: tag check again
{
foreach AllActors( class'Mover', M )
{
if ( (M != self) && (M.ReturnGroup == ReturnGroup) )
{
M.Leader = self;
M.Follower = Follower;
Follower = M;
}
}
}
}
}
}
</uscript>

<uscript>
function FinishNotify()
{
local Pawn P;

if (WaitingPawn == None)
return; // Xian: don't iterate unless needed

// Note: this does kinda upsets the blanace of Bot decission in case they assigned the current
// instance of the Mover as their special destination, but in most cases it's all about online play;
// although this is not something I recommend for UT as a whole, these changes should help for
// player-only mods that require online gameplay and is made for informative purposes

if ( StandingCount > 0 )
for ( P=Level.PawnList; P!=None; P=P.nextPawn )
if ( P.Base == self)
{
// Xian: is it even relevant to execute code for players since they're aware of mover states ?
if (P.IsA('Bot'))
{
P.StopWaiting();

if ( (P.SpecialGoal == self) || (P.SpecialGoal == myMarker) )
P.SpecialGoal = None;
}

if ( P == WaitingPawn )
WaitingPawn = None;
}

if ( WaitingPawn != None )
{
if (WaitingPawn.IsA('Bot'))
{
WaitingPawn.StopWaiting();
if ( (WaitingPawn.SpecialGoal == self) || (WaitingPawn.SpecialGoal == myMarker) )
WaitingPawn.SpecialGoal = None;
}

WaitingPawn = None;
}
}
</uscript>

This is how it should all be in my opinion :) The code should execute faster. Not tested but in theory, it should be better.

==Subclasses==
* [[Legacy:Types Of Mover|Types of Mover]] is a quick overview of the different classes of mover
* [[Legacy:AssertMover|AssertMover]]
* [[Legacy:AttachMover|AttachMover]]
* [[Legacy:ElevatorMover|ElevatorMover]]
* [[Legacy:GradualMover|GradualMover]]
* [[Legacy:LoopMover|LoopMover]]
* [[Legacy:MixMover|MixMover]]
* [[Legacy:RotatingMover|RotatingMover]]
* [[Legacy:FixedMover|FixedMover]] – custom class that fixes network bugs with movers than rotate in the process of opening or closing

It's possible to change the class of a mover after it's been created, but it requires [[Legacy:Brush Hacking|Brush Hacking]].

==Related Topics==
* [[Legacy:Mover Topics|Mover Topics]] is the hub for all related articles & tutorials on making specific movers
* [[Legacy:Types Of Trigger|Types of Trigger]]
* [[Legacy:Event|Event]]

==Mover Tutorials==
* [[Legacy:Create A Mover|Create A Mover]]
* [[Legacy:Keyframe|Keyframe]]
* [[Legacy:Activating A Mover|Activating a Mover]]

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:LevelInfo (UT)

2016-11-08T16:06:36Z

SeriousBarbie: extended description of Level.TimeSeconds

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Info (UT)|Info (UT)]] >> [[Legacy:ZoneInfo (UT)|ZoneInfo (UT)]] >> LevelInfo (Package: Engine)}}

LevelInfo holds:
* information about the map (default gamemode, author, music, etc).
* information about the zones in the map that don't have a [[Legacy:ZoneInfo (UT)|ZoneInfo (UT)]].

Unrealed will automatically place a LevelInfo when you create a new map. It's located at the origin (0,0,0), but its Advanced -> bHiddenEd flag is set so you can't see it.

The properties of the LevelInfo can be accessed
* [[Legacy:UnrealEd Main Menu|UnrealEd Main Menu]] -> View -> Level Properties
* by pressing the F6 key.
* In script by with the Level pointer in any actor.

More details here: [[Legacy:Level Properties|Level Properties]]

See [[Legacy:LevelInfo|LevelInfo]] for the UT2003 version of this class.

==Properties==

===LevelInfo===
; string Author : Who built it.
; bool bCheckWalkSurfaces : Enable texture-specific physics code for Pawns. <– or would if that code had been implemented.
; bool bHumansOnly : Only allow "human" player [[Legacy:Pawn|pawn]]s in this level
; bool bLonePlayer : No multiplayer coordination, i.e. for entranceways.
; bool bNeverPrecache :
; float Brightness :
; class<[[Legacy:GameInfo (UT)|GameInfo (UT)]]> DefaultGameType : GameInfo to use if ?game= is not in the URL when opening this map.
; string IdealPlayerCount (localized) : Ideal number of players for this level, e.g. 6-8 players.
; string LevelEnterText (localized) : Message to tell players when they enter.
; string LocalizedPkg : Package to look in for localizations.
; int RecommendedEnemies : Number of enemy bots recommended (used by rated games)
; int RecommendedTeammates : Number of friendly bots recommended (used by rated games)
; [[Legacy:Texture (UT)|Texture (UT)]] Screenshot : A preview of the map. (see [[Legacy:Level Screenshot|Level Screenshot]])
; float TimeDilation : Normally 1 – scales real time passage. (This is replicated to network clients.)
; string Title (localized): Name of the map.

===Audio===
; byte CdTrack (const) : Default CD track for level. Don't bother with this.
; float PlayerDoppler : Player doppler shift, 0=none, 1=full.
; Music Song (const) : Default song for level.
; byte SongSection (const) : Default song order for level. ''I haven't tried this, but DigSh.umx has an unusual squence order, with like three songs in one, with sequences 0, 1, and 2 corresponding to plain, action, suspense; so maybe this setting is for the "start pattern". –[[Legacy:TwelveBaud|TwelveBaud]]''

===other properties===
; int AIProfile[8] : TEMP statistics
; float AvgAITime : moving average of Actor time
; bool bAggressiveLOD : Frame rate is well below DesiredFrameRate, so make LOD more aggressive
; bool bAllowFOV : (This is replicated to network clients.)
; bool bBegunPlay : Whether gameplay has begun.
; bool bDropDetail : Frame rate is below DesiredFrameRate, so drop high detail actors
; bool bHighDetailMode : Client high-detail mode.
; bool bLowRes (config) : optimize for low resolution (e.g. TV)
; bool bNextItems : If inventory should be carried by players to the next level (used in co-op and SinglePlayer)
; bool bNoCheating : (This is replicated to network clients.)
; bool bPlayersOnly : Only update players.
; bool bStartup : Starting gameplay.
; string ComputerName : Machine's name according to the OS.
; int Day (transient) : Current date, day of month.
; int DayOfWeek (transient) : Current date, day of week.
; [[Legacy:Texture (UT)|Texture (UT)]] DefaultTexture : This texture will be used if a certain texture can't be loaded.
; string EngineVersion : Engine version.
; [[Legacy:GameInfo (UT)|GameInfo (UT)]] Game : Reference to the [[Legacy:GameInfo (UT)|GameInfo (UT)]]. Not valid on network clients.
; int Hour (transient) : Current time, hour.
; int HubStackLevel :
; ELevelAction LevelAction (transient) : What "Action" the Level is under going. Used by Console.DrawLevelAction() to print those nice "Loading", "Saving", "CONNECTING" and "PRECACHING" messages that we all love so much.
; int Millisecond (transient) : Current time, millisecond.
; string MinNetVersion : Min engine version that is net compatible.
; int Minute (transient) : Current time, minute.
; int Month (transient) : Current date, month.
; [[Legacy:NavigationPoint|NavigationPoint]] NavigationPointList (const) : Beginning of the NavigationPoint List.
; ENetMode NetMode : Tells if this is a standalone game, a dedicated server, a listen server, or a Client in a net game.
; string NextURL : The next map the server will go.
; float NextSwitchCountdown : Amount of time until we go to NextURL (if it is set).
; string Pauser : If paused, name of person pausing the game. (This is replicated to network clients.)
; [[Legacy:Pawn (UT)|Pawn (UT)]] PawnList (const) : Beginning of the Pawn List.
; int Second (transient) : Current time, second.
; [[Legacy:SpawnNotify|SpawnNotify]] SpawnNotify : Beginning of the SpawnNotification List.
; [[Legacy:LevelSummary|LevelSummary]] Summary : LevelSummary is a special object saved in the level, which can by Dynamically Loaded to give the wonderful map summary in the Start Practice Session window.
; float TimeSeconds : Time in (game) seconds since level began play. This variable is not replicated and usually the value starts at 0 as soon as the level has been brought up. Every network member (server, clients) maintains and updates its own copy of it and therefore it may has different values on different network members.
; string VisibleGroups : List of the group names which were checked when the level was last saved
; int Year : Current date, year.

==Enums==

===ENetMode===
; NM_Standalone : Standalone game.
; NM_DedicatedServer : Dedicated server, no local client.
; NM_ListenServer : Listen server.
; NM_Client : Client only, no local server.

===ELevelAction===
; LEVACT_None : Just playin' the game.
; LEVACT_Loading : Loading another/this level.
; LEVACT_Saving : Saving the Game (generally Single Player only)
; LEVACT_Connecting : Connecting to a Server.
; LEVACT_Precaching : Precaching the Level.

==Methods==
; string GetAddressURL() (native, simulated) : Return the URL of this level, which may possibly exist on a remote machine.
; string GetLocalURL() (native, simulated) : Return the URL of this level on the local machine.
; ServerTravel( string URL, bool bItems ) : Jump the server to a new level.

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Enums

2016-10-27T19:01:41Z

SeriousBarbie: added chapter "Enum constants and variables"

An '''enum''' (also '''enumerated type''' or '''enumeration''') is a primitive data type in [[UnrealScript]]. The possible values of an enum type are a list of identifiers, which can be compared not only for equality, but also for order.

==Declaration syntax==
The general syntax of enum declarations is:
'''enum''' ''enumname'' '''{'''
''value1'',''value2'',...
'''}'''
An enum declaration may appear either as standalone declaration, in which case it must be followed by a semicolon, or as inline declaration instead of the type specification in variable declarations. There is no difference between a standalone and inline declaration, in both cased the enum is a direct member of the class.

Remember that all members of an UnrealScript class share the same namespace. An enum declaration may hide any member of a parent class if it has the same name.

Unlike [[structs]], enum types may neither have any modifiers nor contain anything else than their value declarations. By convention, enum names start with the letter '''E''' to easily recognize the type as an enum. This is only a convention, not a requirement, though.

=== Enum constants and variables ===
After an enum has been defined, use that enumname like a [[Types|data type]]. Examples:
<uscript>var EMyEnum MyEnumVar;
const EMyEnum MyEnumConst;</uscript>
It is also possible to define an enum and variable at once using the keyword '''[[Variables#Declaration|var]]''' as prefix:
<uscript>var enum enumname {
value1, value2,...
} variablename;</uscript>

==Value declarations==
The values of an enum type are identifiers, that means they must start with a letter or underscore character, may contain letters, digits and the underscore character and are restricted to a maximum length of 63 characters. Values are separated by commas and there may be an optional comma after the last value.

By convention, enum value names start with a series of capital letters specific to the enum's name, followed by an underscore character. For short enum names this is usually the capitalized enum name, like AXIS_X or AXIS_Y for the [[UE2:EAxis (UT2004)|EAxis]] enum. For longer enum names, often either the initial letters of each enum name part are used or one of the parts, possibly shortened, is capitalized. Examples here are the [[UE1:EDrawType (UT)|EDrawType]] enum with values such as DT_Sprite or DT_Mesh and the [[UE3:ENetRole (UT3)|ENetRole]] enum with values such as ROLE_SimulatedProxy or ROLE_Authority.

In [[Unreal Engine 3]] there may be a [[metadata|metatag]] right after each value declaration to specify the value's [[Metadata#Tags|display name]] in any of [[UnrealEd]]'s [[properties lists]].

A good example for an enum declaration with custom display names for its values is [[UE3:EMaterialAdjustmentType (UT3)|UIRoot.EMaterialAdjustmentType]] in [[UT3]]:
<uscript>
enum EMaterialAdjustmentType
{
ADJUST_None<DisplayName=Clipped>,
ADJUST_Normal<DisplayName=Scaled>,
ADJUST_Justified<DisplayName=Uniformly Scaled>,
ADJUST_Bound<DisplayName=Bound>,
ADJUST_Stretch<DisplayName=Stretched>,
};
</uscript>
As you can see, the display name of an enum value may be totally different from the actual value identifier.

===Implicit enum properties===
Enum types an implicit property '''EnumCount'''. This property is similar to the '''Length''' property of a [[dynamic array]] in that it returns the number of values declared for that enum. In [[Unreal Engine 1]] and 2 it is only available at runtime, but in [[Unreal Engine 3]] it can also be used at compile-time to define [[static array]] sizes. For some reason it doesn't count as constant expression when defining [[constants]].

As a synonym for '''EnumCount''', Unreal Engine 3 also provides the implicit enum value '''''XYZ''_MAX''', where ''XYZ'' is the prefix used for other values in the same enum. For example the [[UE3:EPhysics (UT3)|Actor.EPhysics]] enum has the implicit value ''PHYS_MAX'' representing the value 13. Note that this additional enum value is also exported when generating C++ headers for [[native classes]] in [[Unreal Engine 2]] and earlier, but it's not available to UnrealScript in those engine generations.

==Converting enum values==
===Enum value to number===
Each enum value also stands for a [[byte]] value. Variables of an enum type or function returning an enum value can directly be used as if they were of an integer type. The integer representation of an enum value depends on its position in the value list. The first value represents the integer value 0, the second represents 1, the next 2, then next 3 and so on.

===Numbers to enum values===
Converting generic numbers to enum values is possible (at least in UE3), by assigning to a temporary variable:

<uscript>
local EMaterialAdjustmentType TheEnum;
TheEnum = 3;
`Log(TheEnum);
</uscript>

...will return "ADJUST_Bound". The standard casting syntax for UE3 appears to work:

<uscript>
`Log(EMaterialAdjustmentType(3));
</uscript>

...but this will return "3".

===Enum value to name===
To get the name of an enum value you can use the [[Object#GetEnum|GetEnum]] function. It expects an [[Literals#Objects|object literal]] representing the enum type and the index of the enum value whose name to return.

Take the following call, for example:
<uscript>GetEnum(Enum'EPhysics', 2)</uscript>
This will return the name equal to the [[Literals#Names|name literal]] <code>'PHYS_Falling'</code>. Note that the second parameter of the GetEnum function is actually of type ''int''. Since enum values can also be used as numbers (as described above), you can also pass in variables or function return values of an enum type.

===Enum value to string===
If you [[typecast]] an enum value to string, you will only get the string representation of the numeric representation as described above in "Enum value to number". To get the string representation of the enum value name, you can instead [[typecast]] the return value of the GetEnum function to string.

===String or name to enum value===
This is only really possible in [[Unreal Engine 1]] and 2 and only for enum variables at the class level, because it requires the SetPropertyText function, which was removed in Unreal Engine 3. Simply pass the name of the enum variable as the first parameter and the desired enum value as the second parameter to assign the value to the variable.

{{navbox unrealscript}}

Legacy talk:TriggeredDeath

2016-10-22T00:13:40Z

SeriousBarbie: moved discussion here; added replacement code for TriggeredDeath

'''Ike Bart:''' I first thought it was something that only works when triggered like the [[Legacy:PressureZone|PressureZone]]

'''Ike Bart:''' For some odd reason, scripted pawns that touch the TriggeredDeath come back as ghosts after you die. The only way to kill them off without using any commands to get rid of pawns is to hit them with certain weapons from the [[Legacy:U4et|U4et]] mod for UT.

'''Wormbo:''' TriggeredDeath uses the victim's HidePlayer() method after calling Died(), maybe this messes up the Pawn's states.

[[Legacy:RenameMe|RenameMe]] - TriggeredDeath(UT)

BTW - Could we actually create that WikiTag?

'''Tarquin:''' Sure. But I thought this was a UT-only class

== Replacements ==
=== TriggeredDeathSB ===

<uscript>/******************************************************************************
Fix for UnrealShare.TriggeredDeath: if touching Actor is a ScriptedPawn, it
will be destroyed.
******************************************************************************/
class TriggeredDeathSB extends TriggeredDeath;

auto state Enabled {
function Touch(Actor Other) {
Super.Touch(Other);
if (ScriptedPawn(Other) != None)
Other.Destroy();
}
}
</uscript>Simple replacement for the ScriptedPawn-Does-not-get-killed bug. --[[User:SeriousBarbie|SeriousBarbie]] ([[User talk:SeriousBarbie|talk]]) 20:13, 21 October 2016 (EDT)

Legacy:TriggeredDeath

2016-10-22T00:10:48Z

SeriousBarbie: added hint about ScriptedPawn-bug; moved comments to discussion page

{{classbox|[[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Triggers (UT)|Triggers (UT)]] >> TriggeredDeath (Package: UnrealShare)}}

Any pawn that touches this trigger will be killed. If the pawn is a player pawn, then a death sequence is activated with optional fog. At the start of the death sequence, the player loses all items, including the non-throwable items. During the death sequence, the player has 1 health. The player can still run around and pick up items during the death sequence. If the player picks up a [[Legacy:Health|health]] or [[Legacy:TournamentHealth|TournamentHealth]] item, the death sequence ends, but he/she is missing inventory items.
Due to a bug ScriptedPawns do not get killed. See [[Legacy_talk:TriggeredDeath|discussion page]] for details.

==Properties ==

===TriggeredDeath Group ===
;bool bDestroyItems :If true, destroys all weapons and decorations that enter the collision radius. Note: ''do not'' use this in a Capture the Flag game, as it will destroy a flag that enters its collision volume and thus make it impossible for either team to score thereafter.

;float ChangeTime :How long the death sequence takes in seconds.

;name DeathName :When a [[Legacy:DamageType|DamageType]] such as Burned, Corroded or Drowned is used here, it alters the death message. With nothing here, the death message is the same for falling. ''(So-and-so left a small crater.)''

;vector EndFlashFog :Colored view fog at end of death sequence, similar to the ViewFog in the [[Legacy:ZoneInfo (UT)|ZoneInfo (UT)]] actor.

;float EndFlashScale : If set to a negative value, this makes the scenery darker and the FlashFog more visible as the death sequence ends. At some point, the screen turns totally black.

;sound FemaleDeathSound :Sound used when a female player or bot touches the TriggeredDeath.

;sound MaleDeathSound :Sound used when a male player or bot touches the TriggeredDeath.

;vector StartFlashFog :Colored view fog at start of death sequence.

;float StartFlashScale : This is similar to the EndFlashScale but it affects the initial FlashScale setting.

===Hidden===
; float TimePassed[8]
; PlayerPawn Victim[8] : For flashing PlayerPawn's screen the PlayerPawn must be remembered for ''ChangeTime'' seconds. These arrays stores up to 8 references to players and their flashing time.

Legacy:Canvas

2016-10-21T23:10:29Z

SeriousBarbie: +wiki syntax

{{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Object|Object]] >> Canvas (Package: Engine)}}

The '''Canvas''' is a wrapper for methods for drawing text, [[Legacy:Texture|Texture]]s and [[Legacy:Mesh|mesh]]es on the local player's screen. Canvas objects are passed to various events and functions in the various classes, e.g. [[Legacy:HUD|HUD]], [[Legacy:Weapon|Weapon]], [[Legacy:GUI|GUI]] classes and [[Legacy:Interaction|Interaction]]s.

See [[Legacy:Canvas (UT)|Canvas (UT)]] for Canvas properties and methods available in UT.

==Properties ==
; bool bCenter : Whether to center the text.
; bool bNoSmooth : Whether bilinear filtering should ''not'' be applied.
; bool bRenderLevel : Will render the level if enabled.
; float ClipX, ClipY : Width and height of the clipping region.
; float CurX, CurY : Current position for drawing relative to origin set by OrgX/OrgY.
; float OrgX, OrgY : Origin for drawing and upper left corner of the clipping window.
; int SizeX, SizeY : Zero-based actual dimensions.
; float SpaceX, SpaceY : Spacing for after executing one of the Draw* methods, i.e. this contains the screen size of the last drawn element.
; byte Style : The values of this variable correspond to the ''ERenderStyle'' enum of the [[Legacy:Actor|Actor]] class.
; color DrawColor : Color to use for drawing. White (R=255,G=255,B=255) means draw everything in its default colors. If any color component is lower than 255 the specific color component of the [[Legacy:Material|Material]] or Font will be drawn darker. Alpha values specify the opacity of the drawn Material or Font. (A=255 means completely opaque) Also see [[Legacy:Color Blending|color blending]].
; Plane ColorModulate : Modulate all colors by this before rendering.
; float CurYL : Largest Y size since DrawText.
; float FontScaleX, FontScaleY :
; font Font : Font for DrawText.
; font MedFont :
; font SmallFont :
; font TinyFont :
; string MedFontName, SmallFontName, TinyFontName :
; [[Legacy:Viewport|Viewport]] Viewport (const) : Viewport that owns the canvas.
; pointer pCanvasUtil (const) : Used internally.

===UT2004 only===
; bool bForceAlpha : Force all drawing to be alpha'ed.
; float ForcedAlpha : How much to force.

==Methods ==

===Texture Drawing===
; DrawTile( [[Legacy:Material|Material]] Mat, float XL, float YL, float U, float V, float UL, float VL ) : This draws a rectangle within the material onto the screen. The upper left of the material will be at the current pen position.
:; Mat : The material to draw.
:; XL, YL : Width and height of the material on the screen, in number of pixels.
:; U, V : coordinates, within the material, of the upper left of the rectangular window.
:; UL, VL : width and height, in pixels, of the window within the material.
; DrawTileClipped( [[Legacy:Material|Material]] Mat, float XL, float YL, float U, float V, float UL, float VL ) : Like DrawTile, but the material is clipped according to the region set by OrgX/OrgY and ClipX/ClipY.
; DrawTileStretched( [[Legacy:Material|Material]] Mat, float XL, float YL ) : Draws the whole material stretched to the specified size. The texture is divided into four parts and only the pixels along the horizontal and vertical center lines are stretched.
; DrawTileJustified( [[Legacy:Material|Material]] Mat, byte Justification, float XL, float YL ) :
; DrawTileScaled( [[Legacy:Material|Material]] Mat, float XScale, float YScale ) : Draws the whole material scaled as specified by the multipliers.
; DrawPattern( [[Legacy:Material|Material]] Tex, float XL, float YL, float Scale ) : Draws the scaled material and repeats it to fill a rectangle of the specified size.
; DrawIcon( [[Legacy:Texture|Texture]] Tex, float Scale ) : Draws the whole texture once with the specified scaling. Unlike most other draw functions, this one doesn't work with all [[Legacy:Material|Material]] classes. Only materials subclassed from [[Legacy:Texture|Texture]] can be used, i.e. you can't use it to draw modifiers (shaders, etc.) or [[Legacy:ScriptedTexture|ScriptedTexture]]s.
; DrawRect( [[Legacy:Texture|Texture]] Tex, float RectX, float RectY ) : Draws the whole texture stretched to the specified size.
; DrawVertical( float X, float height ) : Draw a vertical line. The line's color is specified through DrawColor.
; DrawHorizontal( float Y, float width ) : Draw a horizontal line.
; DrawLine( int direction, float size ) : DrawLine is special as it saves it's original position. Direction: 0 = up, 1 = down, 2 = left, 3 = right
; DrawBracket( float width, float height, float bracket_size ) :
; DrawBox( Canvas canvas, float width, float height ) : Draws a box of the specified size. For some reason this function doesn't draw on the Canvas object you call it from, but needs a Canvas object as the first parameter.

===Text Drawing===
; DrawText( coerce string Text, optional bool CR ) :
; DrawTextClipped( coerce string Text, optional bool bCheckHotKey ) :
; StrLen( coerce string String, out float XL, out float YL ) : Get the size of a string when it would be drawn using the current font. The text will be wrapped according to the canvas width.
; TextSize( coerce string String, out float XL, out float YL ) : Get the size of a string when it would be drawn using the current font. The text will be clipped at the
; WrapStringToArray( string Text, out array<string> OutArray, float dx, string EOL ) : Takes Text and splits it based on how it would fit in the limitation of dx. Also will make a split when it encounters the characters contained in EOL. You can then use the strings of OutArray to make wrapped text by iterating through the array and placing each line of text one step lower than the last. dx would work best as an equation like Canvas.SizeX * 0.2 (20% of the Canvas width).
; WrapText( out String Text, out String Line, float dx, Font F, float FontScaleX ) (static) :
; DrawTextJustified( coerce string String, byte Justification, float x1, float y1, float x2, float y2 ) : Draws String into the box starting at (x1, y1) and ending at (x2, y2). It justifies the text left, center or right, if justification is 0, 1 or 2 respectively.
; DrawScreenText( string Text, float X, float Y, EDrawPivot Pivot ) :

===Actor Drawing===
; DrawActor( [[Legacy:Actor|Actor]] A, bool WireFrame, optional bool ClearZ, optional float DisplayFOV ) :
; DrawScreenActor( [[Legacy:Actor|Actor]] A, optional float FOV, optional bool WireFrame, optional bool ClearZ ) :
; DrawPortal( int X, int Y, int Width, int Height, [[Legacy:Actor|Actor]] CamActor, vector CamLocation, rotator CamRotation, optional int FOV, optional bool ClearZ ) : It doesn't work when using OpenGL. ('''Note:''' The ClearZ argument does nothing, you have to manually clear the Z-buffer or you get strange results. Call the '''Clear''' function below with ClearZ '''true''' before '''DrawPortal''')
;* '''kiff:''' no longer supported in UT3
; vector WorldToScreen( vector WorldLoc ) : Converts the given absolute world coordinates to canvas coordinates. The returned vector's X and Y components contain the coordinates. ''What is the Z component? a dot product of an angle maybe? – Wormbo''
;* '''Missilemaster:''' If WorldLoc is behind you, X and Y are the same as when it's ahead of you, but Z changes from being < 1 to being > 1. So, you'll probably want to put "if( Z < 1.0 )" in front of any drawing functions with this or whatever you draw will also appear when WorldLoc is behind you. ( Worked for me, at least. )
;* '''Sonic:''' Also when Z == 1.0 the teambeacon above players heads dissapears but doing if(Z == 1.0) wont work you will need to do if(float(string(Z)) == 1) so that it limits Z to 2 decimal places, i noticed without the float > string > float conversion it doesnt want to work.
; GetCameraLocation( out vector CameraLocation, out rotator CameraRotation ) : Returns the camera's location and rotation.
; Clear( optional bool ClearRGB, optional bool ClearZ ) :
; SetScreenLight( int index, vector Position, color lightcolor, float radius ) :
; SetScreenProjector( int index, vector Position, color color, float radius, [[Legacy:Texture|Texture]] tex ) :

===Other Functions===
; Reset() : Resets the canvas properties.
; SetPos( float X, float Y ) : Sets CurX/Y.
; SetOrigin( float X, float Y ) : Sets OrgX/Y.
; SetClip( float X, float Y ) : Sets ClipX/Y.
; SetDrawColor( byte R, byte G, byte B, optional byte A ) : Sets the DrawColor.
; Color MakeColor( byte R, byte G, byte B, optional byte A ) (static) : Returns a Color struct with the specified values. When A is not specified or set to 0, then A=255 is used.

===Native Functions===

<UScript>

native(464) final function StrLen( coerce string String, out float XL, out float YL ); // Wrapped!

native(465) final function DrawText( coerce string Text, optional bool CR );

native(466) final function DrawTile( material Mat, float XL, float YL, float U, float V, float UL, float VL );

native(467) final function DrawActor( Actor A, bool WireFrame, optional bool ClearZ, optional float DisplayFOV );

native(468) final function DrawTileClipped( Material Mat, float XL, float YL, float U, float V, float UL, float VL );

native(469) final function DrawTextClipped( coerce string Text, optional bool bCheckHotKey );

native(470) final function TextSize( coerce string String, out float XL, out float YL ); // Clipped!

native(480) final function DrawPortal( int X, int Y, int Width, int Height, actor CamActor, vector CamLocation, rotator CamRotation, optional int FOV, optional bool ClearZ );

native final function vector WorldToScreen( vector WorldLoc );

native final function GetCameraLocation( out vector CameraLocation, out rotator CameraRotation );

native final function SetScreenLight( int index, vector Position, color lightcolor, float radius );

native final function SetScreenProjector( int index, vector Position, color color, float radius, texture tex );

native final function DrawScreenActor( Actor A, optional float FOV, optional bool WireFrame, optional bool ClearZ );

native final function Clear(optional bool ClearRGB, optional bool ClearZ);

native final function WrapStringToArray(string Text, out array<string> OutArray, float dx, optional string EOL);

static native final function WrapText( out String Text, out String Line, float dx, Font F, float FontScaleX );

native final function DrawTilePartialStretched( Material Mat, float XL, float YL ); // rjp

native final function DrawTileStretched(material Mat, float XL, float YL);

native final function DrawTileJustified(material Mat, byte Justification, float XL, float YL);

native final function DrawTileScaled(material Mat, float XScale, float YScale);

native final function DrawTextJustified(coerce string String, byte Justification, float x1, float y1, float x2, float y2);

native final function DrawActorClipped( Actor A, bool WireFrame, float Left, float Top, float Width, float Height, optional bool ClearZ, optional float DisplayFOV);

</UScript>

==External Links==
* [[udn2:CanvasReference]]

==Related Topics==
* [[Legacy:HUD|HUD]] and [[Legacy:HUD Interactions|HUD Interactions]]
* [[Legacy:HudOverlay|HudOverlay]]
** [[Legacy:ScriptedHudOverlay|ScriptedHudOverlay]]

==Discussion==

'''TurkeyFromHell:''' Dude idk when you stuck those in here, but i am eternally grateful you did.. because i can't really do a google search through all my class sources for "native render" and find the DrawActor function now can I? :D <3 Maybe I'll finally be able to draw stuff through walls -.-... we'll see :P

'''OlympusMons:''' Added the native functions, Im not sure if they are ut2k4 only or not so someone might want to check that. I hope Im doing good here, not sure if this is where these native functions should be going or not, the formatting might need to be changed also. Help please :P

[[Category:Legacy Class (UT2003)|{{PAGENAME}}]]
[[Category:Legacy Class (UT2004)|{{PAGENAME}}]]

HoM

2016-10-08T04:30:56Z

SeriousBarbie: Redirected page to Legacy:Hall Of Mirrors

#REDIRECT [[Legacy:Hall Of Mirrors]]

Functions

2016-10-07T04:20:38Z

SeriousBarbie: baaah, anchor set at wrong keyword...

A '''function''' in [[UnrealScript]] is a [[wp:subroutine|subroutine]] associated with a specific [[class]]. Functions can define zero or up to sixteen [[#Parameters|parameters]] and optionally a return type. Various [[#Modifiers|modifiers]] can be used in the declaration to change the way the function can be accessed or how it behaves when called.

[[Operators]] and [[delegates]] are special kinds of functions. Operators have either exactly one (prefix/postfix operators) or two (infix operators) parameters and can use an operator symbol instead of a function name. Delegates are variable-like placeholders you can assign functions to. Calls to a delegate actually call the function assigned to it.

==Function declarations==
===Syntax===
A regular function declaration looks like this:
''[[#Modifiers|[modifiers]]]'' '''function''' ''[[types|[returntype]]]'' functionname '''(''' ''[[#Parameters|[parameter declarations]]]'' ''')''' ''body_or_semicolon''
If the function does not return any value, the return type can be omitted. In this case [[return statement]]s in the function body may not specify any value. Otherwise, if a return value was specified, any return statement must specify an expression that evaluates to that type. Starting with [[Unreal Engine 2]] the compiler will emit a warning if a return type was specified, but the function body does not contain any return statement.
Alternatively, the keyword '''event''' can be used instead of '''function''' without any difference at the UnrealScript level. The '''event''' keyword will only become relevant when writing [[native code]].

'''Note:''' The compiler is not very strict about the order of modifiers and the keywords '''function''' and '''event'''. Especially in the UT3 source code you will sometimes see modifiers between the keyword '''function''' and the return type or function name. This can be very confusing to anyone reading your code, so please always make '''function''' or '''event''' the last keyword before the return type or function name.

===Modifiers===
Before the actual function declaration you are allowed to specify one or more function modifiers. These change the way the function works in certain situations.
{{Infobox EngineVersion|modifier}}

====Access modifiers====
; Private2,3: The function is only accessible within the same class. Not even subclasses can "see" it, which means the usual rules for overriding functions don't apply - subclasses may change the return type and the number and type of parameters. Since they don't see the parent class function, they cannot call it via the [[Super]] keyword.
; Protected2,3: Restricts access to this function to the current class and its subclasses. Subclasses may override the function unless it is also declared as '''final'''.
; Public2,3: The default access rule. If neither '''private''' nor '''protected''' is specified, this is one is implied. Public functions can be called from non-related classes and may be overridden in subclasses, unless the function is also declared as '''final'''.
; Static: Static functions are not tied to specific objects, but to a class. The object literal <code>Self</code> is not allowed within static functions and instance functions (i.e. functions not declared with the '''static''' modifier) can only be called through object references, this includes iterator functions in [[ForEach loop]]s. Because static functions are not executed in the context of any object instance, they can also not be subject to [[replication]].
; Final: As the name suggests, function declarations with this modifier are "final" and can't be overridden in subclasses.

====Call modifiers====
; Exec: Marks the function as potential console command. Note that exec functions are only really called via console commands for certain objects, such as the local PlayerController, that player's HUD, Pawn or selected Weapon and a few other places. The possible places for exec functions may vary from game to game, so have a look at the [[UnrealScript source code]] of your game to find out where you can put exec functions that actually work. When overriding functions, you must also declare the new function with the '''exec''' modifier if and only if the overridden function was declared with it. This means you cannot turn a regular function into a console command!
; K2Call3-x3 : Allows the function to be referenced and called via [[Kismet 2]]{{confirm}}.
; K2Override3-x3 : Related to [[Kismet 2]]{{confirm}}. Effect unknown.
; K2Pure3-x3 : Related to [[Kismet 2]]{{confirm}}. Effect unknown.
; Simulated: Marks the function as valid for execution on clients if the actor containing it was replicated to that client and the local [[role]] of that client is either ROLE_SimulatedProxy or ROLE_DumbProxy. '''Note:''' The modifier '''simulated''' does not imply any kind of replication or even broadcast! Also, this modifier is not inherited when overriding functions - every super function call evaluates that super function's '''simulated''' modifier separately, potentially breaking the chain of super calls on clients!
; Singular: Restricts recursive function calls by only ever allowing a single singular function to execute per object instance. If a singular function is called, the engine first checks if the object instance the function was called on already executes a singular function. If it does, the new function call is ignored.

====Network modifiers====
These modifiers affect function [[replication]] in [[Unreal Engine 3]]. Earlier engine generations use the [[replication block]] to define these.
; Client3: Specifies that this function should be replicated to the client owning the actor if it is called on the server. This modifier automatically makes the function '''simulated''' as well.
; DemoRecording3-x1: Specifies that this function should be replicated to the demorecording driver (applicable to server-side demo recording only). It will only be executed during demo playback. This modifier automatically makes the function '''simulated''' as well, which makes sense since demo playback essentially is a client environment. Note that '''Client''' function calls are also replicated to the demorecording driver, whereas '''DemoRecording''' ones are replicated only to the driver, not to the real clients.
; Reliable3: Replicated functions will be replicated reliably when marked with this modifier.
; Server3: Specifies that this function should be replicated to the server if it was called on a replicated actor that is owned by the local client.
; Unreliable3: Replicated functions will be replicated unreliably when marked with this modifier, i.e. they may be dropped due to packet loss or bandwidth saturation.

====Implementation modifiers====
; Const3: This modifier is actually placed after the closing parenthesis of the parameter list. It will be passed to the generated native header file, but has no effect in UnrealScript.
; DLLImport3-x2: Indicates that the function should be linked to the specified [[wp:DLL|DLL]] in [[DLLBind]].
; Event: As mentioned in the [[#Syntax|Syntax]] section above, the keyword '''event''' may replace the keyword '''function''' without any effect on the UnrealScript level. However, when exporting native header files from script code, '''event''' functions will have calling stubs generated so the UnrealScript function can be called more easily from C++ code. These generated C++ methods have the name <code>event''NameOfUnrealScriptFunction''</code> and their parameters and possible return type reflects the UnrealScript function declaration.
; Intrinsic1,2: See '''native'''.
; Intrinsic(''number'')1,2: See '''native(''number'')'''.
; Iterator: Native functions with the '''iterator''' modifier can only be used as the iterator function of a [[ForEach loop]]. This modifier may not be used for non-native functions.
; Latent: Native functions with the '''latent''' modifier may only be called directly from [[state code]] (but not within any [[ForEach loop]]) and usually pause state code execution at least until the next tick, possibly even longer. This modifier may not be used for non-native functions.
; Native: The actual implementation of this function resides in native code in a C++ function with the name <code>exec''NameOfUnrealScriptFunction''</code>. Very early [[Unreal Engine 1]] versions used the keyword '''intrinsic''' instead. Similar to '''simulated''' functions, native functions can be called clientsidely on replicated actors even if the local [[role]] is ''ROLE_SimulatedProxy'' or ''ROLE_DumbProxy''.
; Native(''number''): Same as the plain '''native''' modifier, but additionally the function gets its own [[UnrealScript bytecode]] token. ''Even if you can write native code for your mod, you should never specify numbers for your native functions!''
; NoExport3, NoExportHeader3-x2: Prevents this function from being exported to native headers.
; Virtual3: This modifier is just passed through to exported native headers and has no effect in UnrealScript.

===Parameters===
A function may have zero to sixteen parameters. If you need to pass more values to your function, consider using combining some or all of them to a [[struct]]-type parameter or passing them as a [[static array|static]] or [[dynamic array]].

====Syntax====
Parameter declarations have the following syntax:
''[parameter modifiers]'' [[type]] parametername
As with other [[variable declaration]]s, the parameter name may optionally followed by a number in square brackets to declare the parameter as [[static array]]:
''[parameter modifiers]'' [[type]] parametername'''['''arraysize''']'''
If more than one parameter is specified, the individual parameters must be separated by commas. The type and any modifiers only apply to the parameter they were specified for.

====Parameter modifiers====
; coerce: Automatically performs [[typecasting]] of values passed to this parameter, if the parameter is of a primitive type other than [[enum]]. Note that the built-in numeric types [[int]], [[float]] and [[byte]] are automatically typecasted to each other even without this modifier. Enum conversion to these numeric types is automatic as well. This modifier can also be applied to the return type of the function.
; const3: For native functions this modifier is passed to the generated native headers. In UnrealScript, it prevents changes to the parameter within the function body, i.e. the value of the parameter must remain as the value that was passed when the function was called.
; init3-x2: Effect unknown.
; optional: Specifying the parameter in function calls is optional. Omitted parameters assume a default value, which is the parameter type's null value. In Unreal Engine 3 it is also possible to specify a different default value:
'''optional''' [[type]] parametername '''=''' defaultvalue
:The ''defaultvalue'' can be any expression you could use on the right side of a variable assignment. It will be evaluated as if it was placed between the last local variable declaration and the first executable code statement of the function. In other words, you can call functions here and use any of the function's parameters or local variables. Evaluation of the expression is skipped if that parameter was specified when calling the function.
; out1,2: If the parameter is a variable or an array element or struct member accessed through a variable (as opposed to a literal, or function return value or an array element or struct member accessed through a function return value), any modification to the parameter inside the function is copied back into the variable originally passed to the function after the function returns. '''Note:''' This is not "call by reference", but actually [[wp:Evaluation strategy#Call by copy-restore|call by value-result]]. Instead of only copying the value when passing the parameter in, it needs to be copied again when returning from the function, so declaring a parameter as '''out''' is actually more expensive in UnrealScript prior to Unreal Engine 3. (see below)
;out3: The parameter is passed [[wp:Evaluation strategy#Call by reference|by reference]] instead of being copied. Any changes to the parameter inside the function become immediately visible in the variable, struct member or (static) array element originally passed to the function. For large dynamic arrays or structs passing by reference (via '''out''' parameter) may be more efficient than passing by value. '''Note:''' Due to the way dynamic arrays are implemented, you can't pass dynamic array elements or parts of them to an '''out''' parameter. Passing an entire dynamic array via '''out''' parameter is possible, and for large arrays even recommended.
; skip: Only allowed for the second parameter of a native [[operator]] declaration. The native implementation of the operator may choose to not evaluate the second operand if the operator result can be determined by evaluating only the first operand. This is used for the operators <code>&&</code> and <code><nowiki>||</nowiki></code> to skip evaluating the second boolean expression if it is not required.

Parameters are evaluated at the time the function is called, before deciding if or where to execute the function body. Parameter expressions are evaluated from left to right in the context of the calling code and with the exception of parameters declared with the '''out''' modifier, UnrealScript always uses the [[wp:Evaluation strategy#Call by value|call-by-value evaluation strategy]].
Note that reference type values are not objects, but object references! Passing objects to functions duplicates the object reference, not the object itself.

===Locals===
Functions can have also locals which are just like [[Variables|class variables]] with the exception of no modifiers. Locals can only be declared in functions and they are only available within functions.

See [[Variables#Local_variables|Local variables]].

==Function calls==
Functions can be called from [[state code]] and other functions. In theory they can also be called from a [[replication block]], but this is impractical as replication conditions are tested relatively often and at unexpected times, while function calls (especially to non-native functions) are a much more expensive operation than checking variable values.

Function calls must not be confused with executing functions. The call to and execution of a function can happen in different places if replication is involved, and some [[#Modifiers|modifiers]] (e.g. ''singular'' or no ''simulated'') may prevent the execution of a called function at runtime altogether.

===Syntax===
A typical function call uses the following syntax:
[''objectreference'' '''.'''] ''functionname'' '''(''' [''expression'' [''',''' ''expression'' [''',''' ...]]] ''')'''
The object reference in front of the function name provides a "calling context" for the function. The function will be called on the specified object. If the reference is left out, the function is called in the same context as the code calling the function.

For static functions the context is actually the class of the specified object reference. To specify a context class directly, you can use the following syntax instead:
''classreference'' '''. static .''' ''functionname'' '''(''' [''expression'' [''',''' ''expression'' [''',''' ...]]] ''')'''

Instead of an object reference, you can also use one of the [[function call specifiers]] '''Super''' or '''Global''' to tell the compiler you want a different implementation of a function to be called.

===Determining the target function===
When the UnrealScript interpreter or compiler (only for ''final'' functions and when using the [[Super]] call specifier) encounters a function call, it needs to figure out, which implementation actually gets called. It does so by starting at the class of the context object reference. The compiler and [[UnrealScript bytecode]] interpreter have similar rules for this, but there are some important differences. The most important difference is that the compiler doesn't actually execute the code, so it doesn't know e.g. the content of variables at runtime. Due to this restriction, the compiler relies on variable types instead of the referenced objects to find the calling context. Similar restrictions apply to determining the [[state]] of the context object. The compiler can only assume that functions without a context object reference are called in the context of the state the calling code resides in. At runtime, the context state can change before a state function returns if any code that function executes calls the '''GotoState()''' function.

If the context class and context object state have been determined, the engine first looks in that state for a function definition with the specified name. If none is found, it continues to look in the parent state for extended states or in the parent class version of the same state for inherited states. It continues upwards until no more parent states are found. In that case, non-state functions with the specified name are looked up in a similar manner, starting at the context class. If the compiler can't find any function definition this way, it issues an error. Due to the compiler check the engine should always find a function to call at runtime, but there are some special cases the compiler can't catch and in these cases the engine crash will crash with a "Failed to find function" error.

===How function calls are processed===
After the engine resolved, which function it should actually call, it evaluates the function call.

Before looking at the function itself, all specified argument expressions are evaluated from left to right. If an expression contains a function call, its return value is determined by calling that function first. Some native functions have non-standard argument evaluation methods, especially the operators <code>&&</code> and <code>||</code>, which may choose to not evaluate their second argument at all.

If the function has [[replication]] logic attached, the engine checks if it needs to replicate the call. If that's the case, the function's argument values are wrapped up along with the function name in a network packet, which is sent to the remote side. The ''local'' function call then returns immediately and if the function has a return type, it returns that type's null value. When the remote side receives the function call, it first checks whether it actually wants it (in case something strange happened) and then continues to process the function call similar to a local function call as described below.

Now that the function's argument values are known and the is to be executed locally, the engine checks if and how it should actually execute the function. If the function is neither ''native'' nor ''simulated'', but the context object is an actor with <code>[[Role]] <= ROLE_SimulatedProxy</code>, then the function is not executed. Similarly, if the function is ''singular'' and the context object already executes the same or another ''singular'' function, the function is not executed. And lastly, if the function is a [[Legacy:Probe_Function|probe function]] and the probe event with the same name was disabled, then the function is not executed. In all these cases, if the function has a return type, the corresponding null value is returned.

If the engine found that the function should be executed, it initializes all parameters (except '''out''' parameters in [[Unreal Engine 3]]) as local variables with an initial value equal to the corresponding argument value. Omitted optional parameters with a default value expression are initialized accordingly at this point. Any other optional parameters and local variables are initialized with their type's corresponding null value. After that is done, the code in the function body is [[code execution|executed]] until either a [[return statement]] or the end of the function body is reached. If the function has a return type, but code execution did not reach any return statement, the function's return value is the return type's corresponding null value.

In [[Unreal Engine 1]] and [[Unreal Engine 2|2]], if the function has any '''out''' parameters, the final values of those local variables are copied back to the corresponding variables originally passed in as arguments.

Finally, if the function was called as part of an expression, its return value is used to further evaluate that expression.

===Limits for function calls===
Generally there is a limit of at most 250 nested function calls at runtime. If this limit is exceeded, the engine will crash with an "Infinite script recursion" error. The value 250 may look like a severe restriction, but in practice you will rarely ever run into it unless your code contains logic errors (bad <code>CheckReplacement()</code> logic is a frequent cause) or you tried to explicitly implement a recursive algorithm with recursive function calls. In the latter case you may have to try and find a different solution using either a stack-like structure or a completely different algorithm. Generally, recursion must be viewed as an expensive operation in UnrealScript.

A function call is nested in another function call if it happens as part of the containing function's [[code execution]]. Function calls as part of a parameter expression for another function call are nested in the calling environment, not in the called function. For example:
<uscript>
function int X(int A, int B)
{
return Y(Z(A, B)); // calls Z(A, B), then calls Y(result of Z call), then returns result of Y call
}

function int Y(int C)
{
return C - 1;
}

function int Z(int D, int E)
{
return D + E;
}
</uscript>
Here, when calling <code>X()</code>, the maximum nesting level is 2 while executing <code>Z()</code> and <code>Y()</code>, respectively.

Native functions do not increase the nesting level, but UnrealScript functions called from native functions (e.g. <code>*BeginPlay()</code> called from <code>Spawn()</code>) will resume with the nesting level at which the native function was called.

{{navbox unrealscript}}

Typecasting

2016-10-07T04:19:34Z

SeriousBarbie: set red link to correction destination

'''Typecasting''' or '''type conversion''' is the concept of converting one [[data type]] into another, for example the turning the string "1" into the numeric value 1.

Type conversions from or to primitive data types, including conversions between the struct types [[vector]] and [[rotator]] and from a reference type, are called '''primitive casts'''. Type conversions between different classes of object references are called '''dynamic casts'''. Type conversions between different [[class limiter]] types or from an object reference to a class limiter type are called '''metacasts'''.

==Explicit conversion syntax==
To explicitly convert a value of one type to another, use the following syntax:
''typename'''''('''''value''''')'''
Typename is the type to convert the value to. As you can see, this syntax looks like a function call and is a good reason why your [[functions]] should not have the same name as any built-in or user-defined types. If a function and a type of the same name are found, the function call takes precedence over the typecast.

'''Note:''' The compiler will throw an error message if the typecast is redundant, for example because the target type is identical to the value's type, or will always fail, for example when casting between classes from unrelated branches of the class tree.

==Implicit type conversion==
Certain type conversions are done automatically.

===Numeric types===
The types ''int'', ''float'' and ''byte'' are automatically converted into each other when an assignment, [[operator]] or function call require it.
Especially for byte values this is essential, because only the increment, decrement and combined assignment operators are defined for the type ''byte''. All other operators, such as + or - actually are ''int'' operators returning ''int'' values. The reason why you can still use them as expected is implicit type conversion:
<uscript>
local byte A, B, C;

C = A + B; // actually compiled as: C = byte(int(A) + int(B));
</uscript>
Keep in mind that these implicit conversions have the same effects like explicit conversions. The *= and /= operators for the ''int'' type actually expect a ''float'' value as the second operand, so <code>x *= 2</code> is not exactly the same as <code>x = x * 2</code>, because the the latter performs actual integer multiplication, while the former internally performs floating point multiplication, which may produce rounding errors for very large values.

===Object and class limiter types===
Another kind of implicit type conversion happens when assigning an object reference of a certain class to a variable whose type is a parent class of the object's class. This is a direct consequence of [[wp:object-oriented programming|object-oriented programming]] and does not alter the referenced object itself in any way, only the ''view'' on the object through the reference. This kind of conversion is done implicitly because it is a common task and will never fail. In fact, the compiler ''refuses'' any explicit type conversion to a super class because this is how OOP works.

Similarly, a [[class limiter]] type of a certain metaclass is implicitly converted to a class limiter type whose metaclass is a parent class of the first type's metaclass. Like with object typecasts, the compiler actually refuses explicit typecasts to a class limiter for a parent class.

For engine implementations that support [[interfaces]], object references can be implicitly converted to all implemented interfaces when assigning the reference to a variable of the interface type. Note that this does ''not'' apply to class limiters, those strictly follow the class hierarchy without respecting the "cross connections" created by implementing interfaces!

===Parameters defined with ''coerce''===
[[Functions]] and [[operators]] can apply the keyword [[coerce]] to their parameter declarations to instruct the compiler to automatically perform type conversion on values passed when the function or operator is called. That is only possible if an explicit type conversion exists from the value's type to the parameter's type. See the following section for a list of possible type conversions.

Usually the ''coerce'' keyword is only used for [[string]] parameters. It is widely used in the built-in string functions and operators and in the logging functions.

==Primitive casts==
Not all possible combinations of type conversions can actually be performed. For example, converting a floating point value to a class or a struct value to a name does not provide any meaningful result. This section lists all built-in primitive casts. These conversions will happen automatically when passing values to function parameters declared with the [[coerce]] modifier, unless the conversion requires casting to an [[enum]] type.

Note that it might be a good idea to specify literals of the target type directly instead of typecasting from a different type. For example <code>rotator(vect(0.0,1.0,0.0))</code> should be written as <code>rot(0,16384,0)</code> instead.

===bool to...===
; ...byte, int or float : Returns 1 (or 1.0) for the value ''True'' and 0 (or 0.0) for the value ''False''.
; ...string : Returns the localized version of the strings "True" or "False" for the values ''True'' and ''False'' respectively.

===byte to...===
; ...bool : Returns ''False'' for the byte value 0 and ''True'' for any other value.
; ...[[enum]] types : Returns the enum constant corresponding to the numeric value. (0 -> first value, 1 -> second value, etc.)
; ...float : Byte to float conversion is also lossless and returns a float with the same numeric value as the byte value.
; ...int : Byte to int conversion is lossless and simply returns an int with the same numeric value as the byte value.
; ...string : Returns the decimal string representation of the byte value.

All byte conversions also apply to values of enum types, with the first enum constant corresponding to 0, second constant to 1, etc.

===int to...===
; ...bool : Returns ''False'' for the int value 0 and ''True'' for any other value.
; ...byte : Int to byte conversion truncates the binary representation of the int value to the least significant eight bits. Negative int values are stored in [[wp:two's complement|two's complement]], so for example converting -1 to byte results in the value 255.
; ...float : Int to float conversion returns the nearest possible float value. This is unproblematic for values between -16777216 (0xFF000000) and +16777216 (0x1000000), but for larger positive or smaller negative values the float data type is not precise enough, so rounding will occur.
; ...[[enum]] types : Performs conversion to byte, then returns the enum constant corresponding to the resulting numeric value. (0 -> first value, 1 -> second value, etc.)
; ...string : Returns the decimal string representation of the int value. Negative values are preceded by a minus sign, positive values do not have a sign in their string representation.

===float to...===
; ...bool : Returns ''False'' for the float value 0.0 and ''True'' for any other value.
; ...byte : Float to byte conversion has the same result as float to int conversion, followed by int to byte conversion.
; ...[[enum]] types : Performs conversion to byte, then returns the enum constant corresponding to the resulting numeric value. (0 -> first value, 1 -> second value, etc.)
; ...int : Float to int conversion truncates any digits after the decimal point. If the value before the decimal point exceeds the range of valid int values, the binary (or hexadecimal) representation of the value is truncated to the least significant 32 bits (8 hex digits) and the resulting value is the two's complement representation of the resulting int value. An important side effect of this conversion is that the resulting int value might no longer resemble the magnitude or even sign of the original float value! NaN and infinity values are always converted to 0.
; ...string : Returns the decimal string representation of the float value with a fixed number of digits after the decimal point and as many digits before the decimal point as necessary. Negative values are preceded by a minus sign. The number of digits after the decimal point is hard-coded and varies from game to game. For example, [[UT]] emits six digits, [[UT2003]] and [[UT2004]] only two. For obvious reasons this greatly limits the accuracy for small values. Scientific notation is not supported.

===name to...===
; ...bool : The result is ''False'' for the name value <code>'None'</code> and ''True'' for any other name.
; ...string : The result is the normalized string representation of the name value.

===string to...===
; ...bool : The result is ''True'' for the string "true", both in the English and localized version, as well as any string that, when converted to int, stands for a number other than zero. Any other string results in the value ''False''.
; ...byte : Has the same result as string to int conversion, followed by int to byte conversion.
; ...int : Expects a decimal representation of the numeric value, potentially preceded by a plus or minus sign. If the resulting number exceeds the int range, the 32 least significant bits of its binary representation are used. Binary, octal or hexadecimal string representations are not supported. Leading spaces are ignored. Number recognition stops at the end of the string or the first non-digit character.
; ...name : This conversion is only allowed in [[Unreal Engine 3]] and returns a name value that case-insensitively equals the input string. If the name value was not used before, its capitalization is the same as the original string's, otherwise capitalization may differ.
; ...rotator : Expects a string containing at least two commas, which are used to divide the string. All three parts are converted as described for string to int conversion above. The first value becomes the rotator value's Pitch component, the second the Yaw component and the third the Roll component. If the string contains no or only one comma, only Pitch or Pitch and Yaw are filled, while the remaining components stay 0.
; ...vector : Expects a string containing at least two commas, which are used to divide the string. All three parts are converted as described for string to float conversion above. The values become the X, Y and Z components of the vector. If the string contains no or only one comma, only the X or X and Y components are filled, while the remaining components stay 0.
Note that strings can't be converted to object references or name values (except for Unreal Engine 3) using the typecasting syntax. To load or find an object reference via the object's string name, use the [[DynamicLoadObject() function]].

===rotator to...===
; ...bool : Returns ''False'' if Pitch, Yaw and Roll components are zero, otherwise ''True''.
; ...string : Returns the string representations of the Pitch, Yaw and Roll components of the rotator, separated by commas. Each component value is normalized to the range of 0 to 65535. If you want the string representations of actual integer values, you need to typecast the components separately.
; ...vector : Returns a [[wp:unit vector|unit vector]] (i.e. VSize() == 1.0) pointing in the direction described by the Pitch and Yaw components of the rotator value. The zero rotator <code>rot(0,0,0)</code> corresponds to the unit vector pointing in positive X-axis direction <code>vect(1.0,0.0,0.0)</code>. The result is the same as the [[Functions#out_parameter|out parameter]] X of the GetAxes() function.

===vector to...===
; ...bool : Returns ''False'' for the zero vector, otherwise ''True''.
; ...string : Returns the string representations of the X, Y and Z components, separated by commas. Each component value is converted as described for the float to string conversion above, so small values may suffer from rounding errors.
; ...rotator : Returns a rotator whose Pitch and Yaw components represent the same orientation as the vector. The Roll component is always zero. Since the zero vector does not have any orientation, it is defined to result in the zero rotator <code>rot(0,0,0)</code>.

===Object to...===
; ...bool : Returns ''False'' for the value ''None'' and ''True'' for any object reference.
; ...string : Returns the string representation of the object. In Unreal Engine 3 only the string representation of the object's name is returned. Previous engine generations also include the object's package and group(s), separated by dots.
These conversions also apply to class limiter type values.

==Reference type conversions==
Unlike primitive casts, type conversions between different reference types do not modify the reference in any way. They only act as a kind of "gate" for accessing objects so you don't accidently access variables or call functions of objects that don't have those variables or functions.

There are two types of reference typecasts, dynamic casts and metacasts. Dynamic casts are used to convert to a different type of object, and metacasts are used to convert to a different type of class. Both have in common that they don't actually change the reference being typecasted. That means, after a successful dynamic or metacast, the result is still a reference to the same object. However, if the typecast was not successful, the result is the null reference ''None''. This means, whenever you can't be 100% sure the typecast was successful, you need to perform an additional check on the result to make sure you're not accidently [[accessing None]].

===Dynamic casts===
A dynamic cast typecasts an object reference of a certain class, for example Actor, to a subclass, for example Inventory.
Attempting to typecast to a class that is not a subclass of the original object reference type will be refused by the compiler, either for being redundant (i.e. casting to te same class or a parent class) or because the conversion would always fail. Examples of conversions that will always fail include Pawn to Inventory and Weapon to Ammo, or more generally all conversions between unrelated branches of the class tree.

====Examples====
Controllers have a reference to their currently controlled Pawn, but it's of type "Pawn". Now neither UT200x nor UT3 actually use pawns of type Pawn directly, instead they use the class xPawn and UTPawn by default, which are (indirect) subclasses of Pawn.
<uscript>
local Controller C;

// getting Pawn's health:
log(C.Pawn.Health); // yup, no typecasting at all - Health is defined in Pawn

// is the Pawn currently invisible?
log(xPawn(C.Pawn).bInvis);
</uscript>
Vehicles are Pawn subclasses as well:
<uscript>
local Controller C;

// currently driving a vehicle?
log(Vehicle(C.Pawn) != None);

// sitting in a turret seat?
log(ONSWeaponPawn(C.Pawn) != None);

// accessing the vehicle driver:
log(Vehicle(C.Pawn).Driver);

// accessing vehicle health and driver health:
log(C.Pawn.Health @ Vehicle(C.Pawn).Driver.Health);

// accessing an Onslaught vehicle's active driver weapon (might change, e.g. for Leviathan):
log(ONSVehicle(C.Pawn).Weapons[ONSVehicle(C.Pawn).ActiveWeapon]);

// Ready for some serious typecasting action?
// The Hellbender side turret stores the last fired sky mine projectile as combo target for bots.
// Let's find its location, but with all the usual checks to prevent Accessed Nones:
if (ONSWeaponPawn(C.Pawn) != None && ONSPRVSideGun(ONSWeaponPawn(C.Pawn).Gun) != None && ONSPRVSideGun(ONSWeaponPawn(C.Pawn).Gun).ComboTarget != None)
log(ONSPRVSideGun(ONSWeaponPawn(C.Pawn).Gun).ComboTarget.Location);
</uscript>
'''Note:''' Usually you would avoid complex typecasting expressions and instead store part in variables. But if you only access things once, you might actually do it like in the last example above.

===Metacasts===
If the result of a type conversion is a [[class limiter]] type, the conversion is also called metacast. Metacasts are not limited to class references, but can also be used to convert from the most-generic type Object. Class references are special object references after all. Like for dynamic casts, metacasts between different class limiter types will only be accepted by the compiler if the target limiter metaclass is a subclass of the casted class limiter's metaclass. Typecasting to the same metaclass or one of its parent classes is refused for being redundant and typecasting to a metaclass in an unrelated branch of the class tree is refused because it will always fail.

====Examples====
The most common use for metacasts is when loading classes with the [[DynamicLoadObject() function]]:
<uscript>
local class<Actor> ActorClass;

ActorClass = class<Actor>(DynamicLoadObject(ActorClassName, class'Class'));
Spawn(ActorClass);
</uscript>
The above example only works because of the metacast. DynamicLoadObject() only returns a reference of type Object, so a typecast is definitely required. A simple dynamic cast to type Class (which would actually be a metacast to <code>class<Object></code>)will not work here, because the Spawn() function requires an Actor class as its parameter.

Just for fun - weapon class roundtrip:
<uscript>
log(class<WeaponDamageType>(class<InstantFire>(class'AssaultRifle'.default.FireModeClass[0]).default.DamageType).default.WeaponClass); // logs XWeapons.AssaultRifle
</uscript>
What happened there? First we access the FireModeClass[0] of class [[UE2:AssaultRifle (UT2004)|AssaultRifle]], which returns class [[UE2:AssaultFire (UT2004)|AssaultFire]]. That's an [[UE2:InstantFire (UT2004)|InstantFire]] subclass and its DamageType property returns class [[UE2:DamTypeAssaultBullet (UT2004)|DamTypeAssaultBullet]]. That, in turn, is a [[UE2:WeaponDamageType (UT2004)|WeaponDamageType]] with its WeaponClass set to class AssaultRifle. Note that all of these are classes, not instances, so we always need to access default values via "<code>.default.</code>".

==Other conversions==
Some type conversions are not allowed by the compiler. For example typecasting a string to a reference type will not work. If you need to perform such conversions, you will have to go a different route.

===string to name===
The string to name typecast is not allowed before [[Unreal Engine 3]]. Instead you have to rely on the SetPropertyText() function and a name-type variable declared at the class scope, optionally encapsulating the conversion in a function:
<uscript>
var name NameConversionHack;

function name StringToName(string str)
{
SetPropertyText("NameConversionHack", str);
return NameConversionHack;
}
</uscript>
So what's happening here is that you let the engine parse your input string and assign it to a variable with the name you specified. The usual conventions for name values apply, so capitalization might get lost if the name was used before already.

===string to object reference===
To convert a string to an object or class reference, you can use the [[DynamicLoadObject() function]]. This will attempt to load the object, if it does not already exist. Such a load operation may require considerable amount of time if the engine needs to load the containing package first. Remember that UnrealScript is executed between rendering frames, so long load operations will cause the game to stop until loading either finished successfully or failed. Note that the DynamicLoadObject() function may emit a log warning if loading failed. See the article on the [[DynamicLoadObject() function]] for more details.

As an alternative for already loaded objects you can use the FindObject() function in Unreal Engine 2 and later. Its usage is similar to that of DynamicLoadObject(), but it will never tryto load objects from disk if they do not already exist.

===string to struct===
While there is not direct support for typecasting strings to a struct value or vice versa, you might want to try using the SetPropertyText() and GetPropertyText() functions on class variables of the desired struct type. The string to struct conversion would be similar to the [[#string to name|string to name]] conversion mentioned above. The other way, struct to string, works as follows:
<uscript>
var YourStructType StructVariable;

function string YourStructToString(YourStructType val)
{
StructVariable = val; // GetPropertyText() only operates on class variables!
return GetPropertyText("StructVariable");
}
</uscript>
You can use this example to find out the required string format for the string to struct conversion.

{{navbox unrealscript}}

Functions

2016-10-07T04:16:53Z

SeriousBarbie: added anchor

A '''function''' in [[UnrealScript]] is a [[wp:subroutine|subroutine]] associated with a specific [[class]]. Functions can define zero or up to sixteen [[#Parameters|parameters]] and optionally a return type. Various [[#Modifiers|modifiers]] can be used in the declaration to change the way the function can be accessed or how it behaves when called.

[[Operators]] and [[delegates]] are special kinds of functions. Operators have either exactly one (prefix/postfix operators) or two (infix operators) parameters and can use an operator symbol instead of a function name. Delegates are variable-like placeholders you can assign functions to. Calls to a delegate actually call the function assigned to it.

==Function declarations==
===Syntax===
A regular function declaration looks like this:
''[[#Modifiers|[modifiers]]]'' '''function''' ''[[types|[returntype]]]'' functionname '''(''' ''[[#Parameters|[parameter declarations]]]'' ''')''' ''body_or_semicolon''
If the function does not return any value, the return type can be omitted. In this case [[return statement]]s in the function body may not specify any value. Otherwise, if a return value was specified, any return statement must specify an expression that evaluates to that type. Starting with [[Unreal Engine 2]] the compiler will emit a warning if a return type was specified, but the function body does not contain any return statement.
Alternatively, the keyword '''event''' can be used instead of '''function''' without any difference at the UnrealScript level. The '''event''' keyword will only become relevant when writing [[native code]].

'''Note:''' The compiler is not very strict about the order of modifiers and the keywords '''function''' and '''event'''. Especially in the UT3 source code you will sometimes see modifiers between the keyword '''function''' and the return type or function name. This can be very confusing to anyone reading your code, so please always make '''function''' or '''event''' the last keyword before the return type or function name.

===Modifiers===
Before the actual function declaration you are allowed to specify one or more function modifiers. These change the way the function works in certain situations.
{{Infobox EngineVersion|modifier}}

====Access modifiers====
; Private2,3: The function is only accessible within the same class. Not even subclasses can "see" it, which means the usual rules for overriding functions don't apply - subclasses may change the return type and the number and type of parameters. Since they don't see the parent class function, they cannot call it via the [[Super]] keyword.
; Protected2,3: Restricts access to this function to the current class and its subclasses. Subclasses may override the function unless it is also declared as '''final'''.
; Public2,3: The default access rule. If neither '''private''' nor '''protected''' is specified, this is one is implied. Public functions can be called from non-related classes and may be overridden in subclasses, unless the function is also declared as '''final'''.
; Static: Static functions are not tied to specific objects, but to a class. The object literal <code>Self</code> is not allowed within static functions and instance functions (i.e. functions not declared with the '''static''' modifier) can only be called through object references, this includes iterator functions in [[ForEach loop]]s. Because static functions are not executed in the context of any object instance, they can also not be subject to [[replication]].
; Final: As the name suggests, function declarations with this modifier are "final" and can't be overridden in subclasses.

====Call modifiers====
; Exec: Marks the function as potential console command. Note that exec functions are only really called via console commands for certain objects, such as the local PlayerController, that player's HUD, Pawn or selected Weapon and a few other places. The possible places for exec functions may vary from game to game, so have a look at the [[UnrealScript source code]] of your game to find out where you can put exec functions that actually work. When overriding functions, you must also declare the new function with the '''exec''' modifier if and only if the overridden function was declared with it. This means you cannot turn a regular function into a console command!
; K2Call3-x3 : Allows the function to be referenced and called via [[Kismet 2]]{{confirm}}.
; K2Override3-x3 : Related to [[Kismet 2]]{{confirm}}. Effect unknown.
; K2Pure3-x3 : Related to [[Kismet 2]]{{confirm}}. Effect unknown.
; Simulated: Marks the function as valid for execution on clients if the actor containing it was replicated to that client and the local [[role]] of that client is either ROLE_SimulatedProxy or ROLE_DumbProxy. '''Note:''' The modifier '''simulated''' does not imply any kind of replication or even broadcast! Also, this modifier is not inherited when overriding functions - every super function call evaluates that super function's '''simulated''' modifier separately, potentially breaking the chain of super calls on clients!
; Singular: Restricts recursive function calls by only ever allowing a single singular function to execute per object instance. If a singular function is called, the engine first checks if the object instance the function was called on already executes a singular function. If it does, the new function call is ignored.

====Network modifiers====
These modifiers affect function [[replication]] in [[Unreal Engine 3]]. Earlier engine generations use the [[replication block]] to define these.
; Client3: Specifies that this function should be replicated to the client owning the actor if it is called on the server. This modifier automatically makes the function '''simulated''' as well.
; DemoRecording3-x1: Specifies that this function should be replicated to the demorecording driver (applicable to server-side demo recording only). It will only be executed during demo playback. This modifier automatically makes the function '''simulated''' as well, which makes sense since demo playback essentially is a client environment. Note that '''Client''' function calls are also replicated to the demorecording driver, whereas '''DemoRecording''' ones are replicated only to the driver, not to the real clients.
; Reliable3: Replicated functions will be replicated reliably when marked with this modifier.
; Server3: Specifies that this function should be replicated to the server if it was called on a replicated actor that is owned by the local client.
; Unreliable3: Replicated functions will be replicated unreliably when marked with this modifier, i.e. they may be dropped due to packet loss or bandwidth saturation.

====Implementation modifiers====
; Const3: This modifier is actually placed after the closing parenthesis of the parameter list. It will be passed to the generated native header file, but has no effect in UnrealScript.
; DLLImport3-x2: Indicates that the function should be linked to the specified [[wp:DLL|DLL]] in [[DLLBind]].
; Event: As mentioned in the [[#Syntax|Syntax]] section above, the keyword '''event''' may replace the keyword '''function''' without any effect on the UnrealScript level. However, when exporting native header files from script code, '''event''' functions will have calling stubs generated so the UnrealScript function can be called more easily from C++ code. These generated C++ methods have the name <code>event''NameOfUnrealScriptFunction''</code> and their parameters and possible return type reflects the UnrealScript function declaration.
; Intrinsic1,2: See '''native'''.
; Intrinsic(''number'')1,2: See '''native(''number'')'''.
; Iterator: Native functions with the '''iterator''' modifier can only be used as the iterator function of a [[ForEach loop]]. This modifier may not be used for non-native functions.
; Latent: Native functions with the '''latent''' modifier may only be called directly from [[state code]] (but not within any [[ForEach loop]]) and usually pause state code execution at least until the next tick, possibly even longer. This modifier may not be used for non-native functions.
; Native: The actual implementation of this function resides in native code in a C++ function with the name <code>exec''NameOfUnrealScriptFunction''</code>. Very early [[Unreal Engine 1]] versions used the keyword '''intrinsic''' instead. Similar to '''simulated''' functions, native functions can be called clientsidely on replicated actors even if the local [[role]] is ''ROLE_SimulatedProxy'' or ''ROLE_DumbProxy''.
; Native(''number''): Same as the plain '''native''' modifier, but additionally the function gets its own [[UnrealScript bytecode]] token. ''Even if you can write native code for your mod, you should never specify numbers for your native functions!''
; NoExport3, NoExportHeader3-x2: Prevents this function from being exported to native headers.
; Virtual3: This modifier is just passed through to exported native headers and has no effect in UnrealScript.

===Parameters===
A function may have zero to sixteen parameters. If you need to pass more values to your function, consider using combining some or all of them to a [[struct]]-type parameter or passing them as a [[static array|static]] or [[dynamic array]].

====Syntax====
Parameter declarations have the following syntax:
''[parameter modifiers]'' [[type]] parametername
As with other [[variable declaration]]s, the parameter name may optionally followed by a number in square brackets to declare the parameter as [[static array]]:
''[parameter modifiers]'' [[type]] parametername'''['''arraysize''']'''
If more than one parameter is specified, the individual parameters must be separated by commas. The type and any modifiers only apply to the parameter they were specified for.

====Parameter modifiers====
; coerce: Automatically performs [[typecasting]] of values passed to this parameter, if the parameter is of a primitive type other than [[enum]]. Note that the built-in numeric types [[int]], [[float]] and [[byte]] are automatically typecasted to each other even without this modifier. Enum conversion to these numeric types is automatic as well. This modifier can also be applied to the return type of the function.
; const3: For native functions this modifier is passed to the generated native headers. In UnrealScript, it prevents changes to the parameter within the function body, i.e. the value of the parameter must remain as the value that was passed when the function was called.
; init3-x2: Effect unknown.
; optional: Specifying the parameter in function calls is optional. Omitted parameters assume a default value, which is the parameter type's null value. In Unreal Engine 3 it is also possible to specify a different default value:
'''optional''' [[type]] parametername '''=''' defaultvalue
:The ''defaultvalue'' can be any expression you could use on the right side of a variable assignment. It will be evaluated as if it was placed between the last local variable declaration and the first executable code statement of the function. In other words, you can call functions here and use any of the function's parameters or local variables. Evaluation of the expression is skipped if that parameter was specified when calling the function.
; out1,2: If the parameter is a variable or an array element or struct member accessed through a variable (as opposed to a literal, or function return value or an array element or struct member accessed through a function return value), any modification to the parameter inside the function is copied back into the variable originally passed to the function after the function returns. '''Note:''' This is not "call by reference", but actually [[wp:Evaluation strategy#Call by copy-restore|call by value-result]]. Instead of only copying the value when passing the parameter in, it needs to be copied again when returning from the function, so declaring a parameter as '''out''' is actually more expensive in UnrealScript prior to Unreal Engine 3. (see below)
;out3: The parameter is passed [[wp:Evaluation strategy#Call by reference|by reference]] instead of being copied. Any changes to the parameter inside the function become immediately visible in the variable, struct member or (static) array element originally passed to the function. For large dynamic arrays or structs passing by reference (via '''out''' parameter) may be more efficient than passing by value. '''Note:''' Due to the way dynamic arrays are implemented, you can't pass dynamic array elements or parts of them to an '''out''' parameter. Passing an entire dynamic array via '''out''' parameter is possible, and for large arrays even recommended.
; skip: Only allowed for the second parameter of a native [[operator]] declaration. The native implementation of the operator may choose to not evaluate the second operand if the operator result can be determined by evaluating only the first operand. This is used for the operators <code>&&</code> and <code><nowiki>||</nowiki></code> to skip evaluating the second boolean expression if it is not required.

Parameters are evaluated at the time the function is called, before deciding if or where to execute the function body. Parameter expressions are evaluated from left to right in the context of the calling code and with the exception of parameters declared with the '''out''' modifier, UnrealScript always uses the [[wp:Evaluation strategy#Call by value|call-by-value evaluation strategy]].
Note that reference type values are not objects, but object references! Passing objects to functions duplicates the object reference, not the object itself.

===Locals===
Functions can have also locals which are just like [[Variables|class variables]] with the exception of no modifiers. Locals can only be declared in functions and they are only available within functions.

See [[Variables#Local_variables|Local variables]].

==Function calls==
Functions can be called from [[state code]] and other functions. In theory they can also be called from a [[replication block]], but this is impractical as replication conditions are tested relatively often and at unexpected times, while function calls (especially to non-native functions) are a much more expensive operation than checking variable values.

Function calls must not be confused with executing functions. The call to and execution of a function can happen in different places if replication is involved, and some [[#Modifiers|modifiers]] (e.g. ''singular'' or no ''simulated'') may prevent the execution of a called function at runtime altogether.

===Syntax===
A typical function call uses the following syntax:
[''objectreference'' '''.'''] ''functionname'' '''(''' [''expression'' [''',''' ''expression'' [''',''' ...]]] ''')'''
The object reference in front of the function name provides a "calling context" for the function. The function will be called on the specified object. If the reference is left out, the function is called in the same context as the code calling the function.

For static functions the context is actually the class of the specified object reference. To specify a context class directly, you can use the following syntax instead:
''classreference'' '''. static .''' ''functionname'' '''(''' [''expression'' [''',''' ''expression'' [''',''' ...]]] ''')'''

Instead of an object reference, you can also use one of the [[function call specifiers]] '''Super''' or '''Global''' to tell the compiler you want a different implementation of a function to be called.

===Determining the target function===
When the UnrealScript interpreter or compiler (only for ''final'' functions and when using the [[Super]] call specifier) encounters a function call, it needs to figure out, which implementation actually gets called. It does so by starting at the class of the context object reference. The compiler and [[UnrealScript bytecode]] interpreter have similar rules for this, but there are some important differences. The most important difference is that the compiler doesn't actually execute the code, so it doesn't know e.g. the content of variables at runtime. Due to this restriction, the compiler relies on variable types instead of the referenced objects to find the calling context. Similar restrictions apply to determining the [[state]] of the context object. The compiler can only assume that functions without a context object reference are called in the context of the state the calling code resides in. At runtime, the context state can change before a state function returns if any code that function executes calls the '''GotoState()''' function.

If the context class and context object state have been determined, the engine first looks in that state for a function definition with the specified name. If none is found, it continues to look in the parent state for extended states or in the parent class version of the same state for inherited states. It continues upwards until no more parent states are found. In that case, non-state functions with the specified name are looked up in a similar manner, starting at the context class. If the compiler can't find any function definition this way, it issues an error. Due to the compiler check the engine should always find a function to call at runtime, but there are some special cases the compiler can't catch and in these cases the engine crash will crash with a "Failed to find function" error.

===How function calls are processed===
After the engine resolved, which function it should actually call, it evaluates the function call.

Before looking at the function itself, all specified argument expressions are evaluated from left to right. If an expression contains a function call, its return value is determined by calling that function first. Some native functions have non-standard argument evaluation methods, especially the operators <code>&&</code> and <code>||</code>, which may choose to not evaluate their second argument at all.

If the function has [[replication]] logic attached, the engine checks if it needs to replicate the call. If that's the case, the function's argument values are wrapped up along with the function name in a network packet, which is sent to the remote side. The ''local'' function call then returns immediately and if the function has a return type, it returns that type's null value. When the remote side receives the function call, it first checks whether it actually wants it (in case something strange happened) and then continues to process the function call similar to a local function call as described below.

Now that the function's argument values are known and the is to be executed locally, the engine checks if and how it should actually execute the function. If the function is neither ''native'' nor ''simulated'', but the context object is an actor with <code>[[Role]] <= ROLE_SimulatedProxy</code>, then the function is not executed. Similarly, if the function is ''singular'' and the context object already executes the same or another ''singular'' function, the function is not executed. And lastly, if the function is a [[Legacy:Probe_Function|probe function]] and the probe event with the same name was disabled, then the function is not executed. In all these cases, if the function has a return type, the corresponding null value is returned.

If the engine found that the function should be executed, it initializes all parameters (except '''out''' parameters in [[Unreal Engine 3]]) as local variables with an initial value equal to the corresponding argument value. Omitted optional parameters with a default value expression are initialized accordingly at this point. Any other optional parameters and local variables are initialized with their type's corresponding null value. After that is done, the code in the function body is [[code execution|executed]] until either a [[return statement]] or the end of the function body is reached. If the function has a return type, but code execution did not reach any return statement, the function's return value is the return type's corresponding null value.

In [[Unreal Engine 1]] and [[Unreal Engine 2|2]], if the function has any '''out''' parameters, the final values of those local variables are copied back to the corresponding variables originally passed in as arguments.

Finally, if the function was called as part of an expression, its return value is used to further evaluate that expression.

===Limits for function calls===
Generally there is a limit of at most 250 nested function calls at runtime. If this limit is exceeded, the engine will crash with an "Infinite script recursion" error. The value 250 may look like a severe restriction, but in practice you will rarely ever run into it unless your code contains logic errors (bad <code>CheckReplacement()</code> logic is a frequent cause) or you tried to explicitly implement a recursive algorithm with recursive function calls. In the latter case you may have to try and find a different solution using either a stack-like structure or a completely different algorithm. Generally, recursion must be viewed as an expensive operation in UnrealScript.

A function call is nested in another function call if it happens as part of the containing function's [[code execution]]. Function calls as part of a parameter expression for another function call are nested in the calling environment, not in the called function. For example:
<uscript>
function int X(int A, int B)
{
return Y(Z(A, B)); // calls Z(A, B), then calls Y(result of Z call), then returns result of Y call
}

function int Y(int C)
{
return C - 1;
}

function int Z(int D, int E)
{
return D + E;
}
</uscript>
Here, when calling <code>X()</code>, the maximum nesting level is 2 while executing <code>Z()</code> and <code>Y()</code>, respectively.

Native functions do not increase the nesting level, but UnrealScript functions called from native functions (e.g. <code>*BeginPlay()</code> called from <code>Spawn()</code>) will resume with the nesting level at which the native function was called.

{{navbox unrealscript}}

Legacy:Dispatcher

2016-10-02T03:03:53Z

SeriousBarbie: added details/corrected number of possible events

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Triggers (UT)|Triggers (UT)]] >> Dispatcher (Package: Engine)}}

''Replaced in [[Legacy:UT2003|UT2003]] by the [[Legacy:ScriptedTrigger|ScriptedTrigger]].''

A dispatcher is a [[Legacy:Trigger|Trigger]] meant for taking another Trigger's [[Legacy:Event|Event]] and sending out a bunch of new events. The dispatcher also has the capability to time when to send out these subsequent events. It is important to point out that the location of a dispatcher is totally irrelevant to its function: it is not affected by players touching it. However, it is generally advisable to put a dispatcher near to the trigger that it will be triggered by or the actors that it will in turn trigger just for organization's sake.

==Properties ==
; name OutEvents[8]: List of events the dispatcher will fire, in order. Note that UnrealEd will ''not'' draw a red line to the actors whose Tag matches these events. (If you're paranoid about this, type the event name in the wrong case; UnrealEd will fix the case if there's a match). If you wish to make more than 8 events, link in a second dispatcher. Gaps in the list are ignored.
; float OutDelays[8]: The time to wait before firing the corresponding event. These are sequential; ie the dispatcher works like this:
* wait time OutDelays[0]
** fire event OutEvents[0]
* wait time OutDelays[1]
** fire event OutEvents[1]
and so on.

OutDelays can be equal to zero; thus firing several events just after each other.

==Examples ==

===Simple example ===

An example would be if you want the dispatcher to trigger 3 events upon the event "xxx" being sent out. The 3 events you want to send out are "yyy" at the same time that "xxx" was sent out, "yyy" again 20 seconds later, and "zzz" at the same time as the second "yyy". The properties you would fill in would be this:
*OutDelays
**'''0''' - 0.0
**'''1''' - 20.0
**'''2''' - 0.0
*OutEvents
**'''0''' - yyy
**'''1''' - yyy
**'''2''' - zzz

===Delaying ===

There is another good trick that can be done with Dispatchers. Sometimes you need to trigger something, but then you need to make it wait before the actual Event happens. This can be done by putting a Dispatcher between the two Events in the chain.

So, if you triggered the Dispatcher's tag xxx, but you needed it to wait 5 seconds before it triggered aaa, here's how it will look:
*OutDelays
**'''0''' - 5.0
*OutEvents
**'''0''' - aaa

Notice that you're not doing anything except triggering an actor that will wait 5 seconds. This is a little trick that editors will sometimes use for such things as properly timing their special effects.

Note that a dispatcher's OutDelays are cumulative. In other words, if you have:
*OutDelay 1
*OutDelay 3
*OutDelay 4

Then the second event is called three seconds after the first, and four seconds after the dispatcher is triggered, and the third event four seconds after the second, and eight seconds in total from the time the dispatcher is called.

===Further examples ===
* [[Legacy:Trigger Systems|Trigger Systems]] – systems using several trigger actors to obtain complex behaviour.
* A tutorial which uses this actor: [[Legacy:Lightning Storm|Lightning Storm]]

==Related Topics ==
* [[Legacy:Dynamics|Dynamics]] – main page for everything about triggers
* [[Legacy:Event|Event]] – overview of how triggering works
* [[Legacy:Types Of Trigger|Types of Trigger]] – summary of the different kinds of trigger actor

==Custom Subclasses ==

===Haltable dispatcher ===

'''Tarquin:''' A dispatcher which stops if triggered while dispatching. This is untested; I have no idea what happens to state label code when a function is called. see [[Legacy:Create A Subclass|Create A Subclass]] for instructions.

<uscript>
state Dispatch
{
function Trigger( actor Other, pawn EventInstigator )
{
gotostate('');
}

Begin:
for( i=0; i<ArrayCount(OutEvents); i++ )
{
if( OutEvents[i] != '' )
{
Sleep( OutDelays[i] );
foreach AllActors( class 'Actor', Target, OutEvents[i] )
Target.Trigger( Self, Instigator );
}
}
}
</uscript>

===Elephant Dispatcher ===

Normal Disp breaks the chain of command. This remembers who Triggered it and passes this information on to the actors it triggers. See [[Legacy:Event|Event]] for details.

<uscript>
//=============================================================================
// ChainDispatcher.
//=============================================================================
class ChainDispatcher extends Dispatcher;
// Remembers who Triggered it
// and passes this information along the chain of command

var actor SavedTrigger ;

//
// When dispatcher is triggered...
//
function Trigger( actor Other, pawn EventInstigator )
{
SavedTrigger = Other ;
super.Trigger( Other, EventInstigator );
}

//
// Dispatch events.
//
state Dispatch
{
Begin:
disable('Trigger');
for( i=0; i<ArrayCount(OutEvents); i++ )
{
if( OutEvents[i] != '' )
{
Sleep( OutDelays[i] );
foreach AllActors( class 'Actor', Target, OutEvents[i] )
Target.Trigger( SavedTrigger, Instigator );
}
}
enable('Trigger');
}
</uscript>

----

[[:Category:Legacy Class (UT)]] [[:Category:Legacy Custom Class (UT)]] [[:Category:Legacy To Do]] move the custom subclasses into sub pages?
[[Category:Legacy Class (UT)|{{PAGENAME}}]]
[[Category:Legacy Custom Class (UT)|{{PAGENAME}}]]
[[Category:Legacy To Do|{{PAGENAME}}]]

Legacy talk:TriggeredAmbientSound

2016-09-24T04:54:37Z

SeriousBarbie: Moved discussion/custom Actor code from article page to discussion page

__TOC__
== TrigAmbSound ==
YoMammy: (04/11/2002)

Advanced -> bStatic IS the problem with the TriggeredAmbientSound. On and above that, the TAS was likely coded up rather quickly for a specific purpose and therefor leaves lots to be desired.

For you sounding pleasure, however, I coded up a much better (if I do say so myself :) ) TAS. Here's a list of its new properties and one other parent property setting worth mentioning:

TrigAmbSound properties:
* var() sound StartSound;
* var() sound AmbSound;
* var() sound StopSound;
* var() bool bInitiallyOn;
* var() float AmbDuration;
* Object/InitialState TriggerToggle or TriggerControl (latter is default)

"StartSound" is where you can optionally place a one-shot sound. This will play when the TAS is triggered. Thereafter, if you specified an "AmbSound" (preferrably a looping sound), it will then play until you untrigger. Once untriggered, if you specified a "StopSound", that will play to finish things up.

"bInitially" should only be set to True if you set Object/InitialState = TriggleToggle. When doing this, the "StartSound" is bypassed and the process proceeds to the "AmbSound"...if any was specified.

If you set "AmbDuration" to anything other than it's default 0.0, the looping ambient sound specified in "AmbSound" will only play for the duration specified. Thereafter, things will work as normal...i.e. you'll still get the "StopSound" when untriggering.

If you want the script, get it here: http://www.gentekcom.com/~diinc/UTMaps/TrigAmbSound.u

In UEd, You'll find it under KeyPoint (where you'd expect). Open up the script and look at it...its ridiculously simple. Now, forgive me for being a smartass, but isn't THIS what you'd expect a TriggeredAmbientSound to do in the first place?

'''CoolDude:''' Too bad, the link above seems to be broken. If anybody has a working one, please add it.

===2001===

'''Tarquin:''' I tried a search of my UT folder for anything with the name "TrigAmbSound" and found this in both a map called DM-2001][ by Wayne Young (AKA Slartybartfast) and wdy_mods.U (whatever that is!) The 'OnWhileTriggered' state sounds like it corresponds to 'TriggerControl' described above. I don't know if it's coincidence that it uses the same name, or if it's an earlier version. If anyone feels like contacting this guy and asking him if we can alter his script & improve it, his website is http://www.ganimede.demon.co.uk/ (and he works for nVidia).

<uscript>
//=============================================================================
// TrigAmbSound.
//=============================================================================
class TrigAmbSound extends Keypoint;

// Re-plays a sound effect if triggered. If in state TriggerToggled,
// the sound is turned off if triggered, and turned on, etc..
// when triggered again. In the OnWhileTriggered state, the instigator
// must stay within the trigger's radius for the sound effect to continue
// playing. bInitiallyOn determines if the sound is playing from the
// start, and does not apply in the OnWhileTriggered state.

var() sound StartSound; // Hmmm. This doesn't do anything yet :(
var() sound LoopSound;
var() sound EndSound;
var() bool bInitiallyOn;

var bool bIsOn;

function BeginPlay ()
{
if (bInitiallyOn) {
// if (StartSound != None) {
// PlaySound (StartSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
// }
if (LoopSound != None) {
PlaySound (LoopSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
}
bIsOn = true;
}
}

state() TriggerToggled
{
function Trigger( actor Other, pawn EventInstigator )
{
bIsOn = !bIsOn;
if (bIsOn) {
// if (StartSound != None) {
// PlaySound (StartSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
// }
if (LoopSound != None) {
PlaySound (LoopSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
}
}
else {
if (EndSound != None) {
PlaySound (EndSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
}
}
}
}

state() OnWhileTriggered
{
function Trigger( actor Other, pawn EventInstigator ) {
bIsOn = true;
// if (StartSound != None) {
// PlaySound (StartSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
// }
if (LoopSound != None) {
PlaySound (LoopSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
}
}

function UnTrigger( actor Other, pawn EventInstigator ) {
bIsOn = false;
if (EndSound != None) {
PlaySound (EndSound, , Float(SoundVolume)/128, , Float(SoundRadius)*25);
}
}

Begin:
bIsOn = false;
}

</uscript>

'''GTD-Carthage:''' Hey, has there been any update here? :o Looks like this is one unsolved problem...

'''SuperApe:''' The bStatic problem? I have a thought about this, although I'm not a UT person. The bStatic problem could be solved with a special Trigger, like the VolumeTrigger is able to toggle bStatic Volumes. The custom Trigger function can simply search for TrigAmbSound actors with the matching Tag and call the TrigAmbSound's Trigger function.

== Simple triggerable AmbientSound ==
A very simple version is this:
<uscript>class AmbientSoundEx expands AmbientSound;

var() bool bInitiallyOn;

var sound MyAmbientSound;

function BeginPlay () {
MyAmbientSound = AmbientSound;
if ( ! bInitiallyOn) AmbientSound = None;
}

function Trigger( actor Other, pawn EventInstigator ) {
if (AmbientSound == None)
AmbientSound = MyAmbientSound;
else
AmbientSound = None;
}

DefaultProperties {
bStatic=False
}</uscript>
Each time this Actor is triggered, it switches its AmbientSound between on and off. If bInitiallyOn is set to True, it switches between off and on.
--[[User:SeriousBarbie|SeriousBarbie]] ([[User talk:SeriousBarbie|talk]]) 00:54, 24 September 2016 (EDT)

Legacy:TriggeredAmbientSound

2016-09-24T04:47:13Z

SeriousBarbie: moved unrelated to discussion page/expanded

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Keypoint (UT)|Keypoint (UT)]] >> TriggeredAmbientSound}}
Re-plays a sound effect if triggered. If in state ''TriggerToggled'', the sound is turned off if triggered, and turned on, etc.. when triggered again. In the ''OnWhileTriggered'' state, the instigator must stay within the trigger's radius for the sound effect to continue playing. ''bInitiallyOn'' determines if the sound is playing from the start, and does not apply in the OnWhileTriggered state. A variance can also be set for the timing, so that the replay time can seem more 'real'.

==Properties ==
=== TriggeredAmbientSound ===
; bool bInitiallyOn: Play sound on start up.
; sound AmbSound: Sound to play.
; float rePlayTime: After this time in seconds has passed, the sound is replayed from the beginning.
; float rePlayVariance: rePlayTime varies until ±rePlayVariance seconds randomly.
; var() bool bPlayOnceOnly: AmbSound is played once only.

=== Object > InitialState ===
;TriggerToggled: Toggles AmbSound on/off.
;OnWhileTriggered: Sound is played only as along as the instigator stays within the trigger's radius.
;None: Actor does nothing (except if bInitiallyOn==True).

== Remarks ==
* If rePlayTime and rePlayVariance are both zero, no sound will be played.
* One of the Great Mysteries of Unreal I and UT: how to get this to work...? It seems problem #1 is Advanced -> bStatic needs to be set to false. However, there are reports that this still doesn't fix it. Several coders have made their own versions, see [[Legacy_talk:TriggeredAmbientSound|Discussion page]]

==Related Topics==
* [[Legacy:Triggering Sounds|Triggering Sounds]] covers the various workarounds
* [[Legacy:Embedding Code|Embedding Code]] explains how to add custom classes to a map

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Open Source/ScoreAwardTrigger

2016-09-22T22:55:09Z

SeriousBarbie: added delete reason - is any Admin still active? oO

{{delete|no delete reason given initially; it is a close duplicate of [[Legacy:ScoreAwardTrigger]]}}

__TOC__
==About==
A trigger that, when triggered, will add points to a player's score.
==Properties==
===Visible===
;int ScorePointsAdded : Amount of points to add.
;sound TriggeredSound : Sound played when triggered.

==Source Code==
<uscript>
/* Written by Jon Steadman */

class ScoreAwardTrigger extends Trigger;

var() int ScorePointsAdded;
var() sound TriggeredSound;

function PostBeginPlay()
{
ReplaceText( Message , "%p", string( ScorePointsAdded ) );
Super.PostBeginPlay();
}

simulated event TriggerEvent( Name EventName, Actor Other, Pawn EventInstigator )
{
if( Role == ROLE_Authority && EventInstigator != None && !Level.Game.bGameEnded )
{
if( EventInstigator.PlayerReplicationInfo != None )
Level.Game.ScoreObjective( EventInstigator.PlayerReplicationInfo,ScorePointsAdded );
else if( EventInstigator.Controller != None && EventInstigator.Controller.PlayerReplicationInfo != None )
Level.Game.ScoreObjective( EventInstigator.Controller.PlayerReplicationInfo, ScorePointsAdded );

if( TriggeredSound != None )
PlaySound( TriggeredSound );
}

Super.TriggerEvent( EventName, Other, EventInstigator );
}

defaultproperties
{
TriggerType=TT_PawnProximity
Message="%p points awarded!"
bTriggerOnceOnly=True
ScorePointsAdded=2
}
</uscript>

==Related Topics==
* [[Open_Source]]
* [[Legacy:Triggers|Triggers]]

----

Legacy:Actor (UT)/Collision

2016-09-12T22:03:29Z

SeriousBarbie: more detailed description - again I run into the trap CollisionHeight==CylinderHeight -.-

These properties determine the size and behaviour of an [[Legacy:Actor_(UT)|Actor_(UT)]]'s [[Legacy:Collision Cylinder|collision cylinder]].

Note that the cylinder is always upright, no matter what the [[Legacy:Actor_(UT)|Actor_(UT)]]'s orientation.

==Properties==

===Boolean Flags===
; bBlockActors : Blocks non-player [[Legacy:Actor_(UT)|Actor_(UT)]]s.
; bBlockPlayers : Blocks player actors ([[Legacy:PlayerPawn|PlayerPawn]]s and [[Legacy:Bot (UT)|Bot (UT)]]s).
; bCollideActors : Collides with other [[Legacy:Actor_(UT)|Actor_(UT)]]s.
; bCollideWorld : Collides with the world geometry.
; bCollideWhenPlacing : Collides when being moved; can't be set into geometry.
; bProjTarget : Set this true if you want your object to be a potential target for projectiles (subject to adjusted aim in single-player mode).

===Collision Cylinder===

The size of the collision cylinder is given by the two properties ''CollisionHeight'' and ''CollisionRadius'': The diameter of the collision cylinder is 2 × CollisionRadius and its height is 2 × CollisionHeight.

==Related topics==
* [[Legacy:Actor (UT)|Actor (UT)]]
* [[Legacy:DuckingZone|DuckingZone]] – A zone where ducking players actually become smaller in Unreal Tournament.
* [[Legacy:Collision Cylinder|Collision Cylinder]] – Details on collision and on <tt>Touch</tt>, <tt>Untouch</tt> and other related events.
* [[Legacy:OCD|OCD]] – Technical lowdown of object collision detection.
* [[Legacy:Actor Overview|Actor Overview]] – More on working with Actors, adding actors to a map and setting properties.

Array

2016-09-09T15:16:07Z

SeriousBarbie: +link to Linked list

'''Array''' may refer to:
* [[Dynamic arrays]]
* [[Static arrays]]
* [[Multi-dimensional arrays]]
''See also:''
* [[Linked list]]

Legacy:VacuumZone

2016-09-02T23:09:53Z

SeriousBarbie: +hint to DamageString

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Info (UT)|Info (UT)]] >> [[Legacy:ZoneInfo (UT)|ZoneInfo (UT)]] >> VacuumZone (Package: Botpack)}}

A vacuum zone kills any player that enters it. It's just another messy way to die. This class behaves in a very similar manner to the [[Legacy:PressureZone|PressureZone]] class, except that it doesn't need to be triggered.

Hint: because the "%k" is missing in its default DamageString <code>%o was depressurized</code>, the death message is not shown. See [[Legacy:Message_Placeholder#ZoneInfo|Message Placeholder]] for details.

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:ZoneInfo (UT)

2016-09-02T21:04:24Z

SeriousBarbie: added link to Legacy:Message_Placeholder#ZoneInfo

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Info (UT)|Info (UT)]] >> ZoneInfo (Package: Engine)}}

This actor sets properties for the [[Legacy:Zone|zone]] its placed in, such as ambient lighting, gravity, location string etc. A number of subclasses hold presets for different types of environment, such as [[Legacy:WaterZone|WaterZone]] and [[Legacy:LavaZone|LavaZone]].

See [[Legacy:Zoning|zoning]] for more on working with zones, and [[Legacy:Actor Overview|Actor Overview]] for more on actors in general.

This may seem obvious, but after adding a new ZoneInfo actor, the map geometry must be rebuilt for that actor's properties (e.g. ZoneLight) to take effect.

See [[Legacy:Zonelight|Zonelight]] for more on this.

See [[Legacy:ZoneInfo|ZoneInfo]] for the UT2003 version of this class.

==Examples ==

This is a small map created by EntropicLqd with examples of all types of zone. Read the enclosed text file for more details.

https://ut.rushbase.net/beyondunreal/wiki/examplemaps/dm-zoneexample.zip

==Properties==

Changing these properties for the [[Legacy:LevelInfo|LevelInfo]] affects all zones without a ZoneInfo actor.

===ZoneInfo Group===

====Zone Properties====
; name ZoneTag : Used to link [[Legacy:ZoneTrigger|ZoneTrigger]] objects to the zone. The Event property of the [[Legacy:ZoneTrigger|ZoneTrigger]] must match the <code>ZoneTag</code> value for the zone to trigger (used to trigger [[Legacy:PressureZone|PressureZone]]s).
; vector ZoneGravity [replicated to clients] : The gravity of a zone. It can be edited to pull objects in any direction (or not). Set it at a negative value to reverse the relevant gravity vector. Decrease the values to create a low-grav zone. Remember, a negative Z component means that the gravity pulls the player downwards. The default gravity for a zone is (0, 0, -950).
; vector ZoneVelocity [replicated to clients] : The velocity of objects that enter the zone. It influences the velocity vector of players (making it increase/decrease) when they enter the zone. Can be used in combination with gravity zones for more realistic gravity effects.
; float ZoneGroundFriction : The friction a player undergoes when walking/running. Decrease the value to create a slippery surface.
; float ZoneFluidFriction : The friction of the fluid in the zone. Only works when there is fluid in any form (i.e. water, slime, tar etc., so <code>bWaterZone = True</code>)
; float ZoneTerminalVelocity : This is the fastest speed an object can travel within the zone. Actors attempting to travel faster than this have their speed capped at this value. This setting can be one reason why [[Legacy:Kicker|Kicker]]s don't always behave quite as expected.
; name ZonePlayerEvent : An event that will be posted to all actors whenever an actor that has bIsPlayer = true set enters or exits the zone. As far as I can tell this event is only posted when the number of "players" within the zone increases to 1 (on entry to the zone), and decreases to 0 (on exit to the zone).
; int DamagePerSec : Amount of damage a player takes while in this zone.
; name DamageType : Set this to <tt>SpecialDamage</tt> if you want to use the <code>DamageString</code>.
; localized string DamageString : see [[Legacy:Message_Placeholder#ZoneInfo]].
; int MaxCarcasses : The maximum number of dead bodies allowed within the zone. Set this is a low number in open areas to improve rendering speeds. Set it to 0 in lava zones and other instant death zones to preserve memory.
; sound EntrySound : The sound to play when an actor enters the zone, e.g. Sound'UnrealShare.Generic.DSplash' for [[Legacy:WaterZone|WaterZone]]s.
; sound ExitSound : The sound to play when an actor leaves the zone, e.g. Sound'UnrealShare.Generic.LavaEx' for [[Legacy:LavaZone|LavaZone]]s.
; class<[[Legacy:Actor|Actor]]> EntryActor : The "graphical effect" to display when an Actor enters the zone. Spawned at the point the actor enters, e.g. class'UnrealShare.WaterImpact' for [[Legacy:WaterZone|WaterZone]]s.
; class<[[Legacy:Actor|Actor]]> ExitActor : The "graphical effect" to display when an actor leaves the zone. Spawned at the point the actor leaves, e.g. class'UnrealShare.FlameExplosion' for [[Legacy:LavaZone|LavaZone]]s.

====Zone Flags====
; bool bWaterZone : Zone is slightly humid (indeed somewhat damp) when set to true. Desert dry if false.
; const bool bFogZone : Allowes fog in this zone.
; const bool bKillZone : The code is commented with <cite>Zone instantly kills those who enter</cite> but in fact this flag seems to do nothing.
; bool bNeutralZone : Players can't take damage in this zone.
; bool bGravityZone : Use ZoneGravity. Setting this to False doesn't seem to have any effect. (?)
; bool bPainZone : True means that players will take damage according to the damage values in this zone. This will be set to True when <code>DamagePerSec</code> is greater than 0 and the zone is triggered.
; bool bDestructive : Destroys carcasses.
; bool bNoInventory : If this is true then inventory items cannot exist within the zone (e.g. when they are dropped they are destroyed).
; bool bMoveProjectiles : This zone should impart velocity to projectiles and effects.
; bool bBounceVelocity : This velocity zone should bounce actors that land in it. (''doesn't have any effect?'')

====per-Zone mesh LOD lighting control====

The number of lights applied to the actor mesh is interpolated between the following properties, as a function of the MeshPolyCount for the previous frame.
; byte MinLightCount : minimum number of lights to use (when MaxLightingPolyCount is exceeded)
; byte MaxLightCount : maximum number of lights to use (when MeshPolyCount drops below MinLightingPolyCount)
; int MinLightingPolyCount :
; int MaxLightingPolyCount :

===LocationStrings Group===
; localized string ZoneName : This string will appear as a player's location on team game HUDs and scoreboards. This is overridden if the player is within the radius of a [[Legacy:LocationID|LocationID]].

===ZoneLight Group===
; byte AmbientBrightness, AmbientHue, AmbientSaturation [all replicated to clients] : These set the color of the ambient lighting for the zone, and work just like the corresponding properties of a light. Ambient light looks pretty awful no matter how you use it though, so you may want to avoid this except for testing purposes. :)
; color FogColor [replicated to clients] :
; float FogDistance :
; const [[Legacy:Texture (UT)|Texture (UT)]] EnvironmentMap :
; float TexUPanSpeed, TexVPanSpeed [both replicated to clients] : These give the panning speed for all surfaces in the zone whose U-Pan or V-Pan [[Legacy:Surface Flags (UT)|Surface Flags (UT)]] have been set.
; vector ViewFlash : Obviously only the X component of this vector has an effect for fog calculation/rendering. ''Further research neccessary.''
; vector ViewFog : Sets a tint on the player's viewport while in that zone. [[Legacy:PressureZone|PressureZone]] changes this value, to do the reddening effect seen in DM-Pressure. It's worth mentioning the idiosyncasies of the ViewFog property here. I think is was me (Tarquin) and Elbundee who figured it out on the JailBreak forum: the vector is treated as XYZ = RGB, with the scale going from 0 to 1.

===Reverb Group===

(also see [[Legacy:Reverb|Reverb]])
; bool bReverbZone [replicated to clients] : Whether this zone should use the reverb settings.
; bool bRaytraceReverb :
; float SpeedOfSound :
; byte MasterGain :
; int CutoffHz :
; byte Delay[6] :
; byte Gain[6] :

===LensFlare Group===
; [[Legacy:Texture (UT)|Texture (UT)]] LensFlare[12] :
; float LensFlareOffset[12] :
; float LensFlareScale[12] :

===Script-only===
; int ZonePlayerCount : Current number of players in this zone.
; int NumCarcasses : Current number of [[Legacy:Carcass|Carcass]]es in this zone. This number is increased and decreased by the carcass classes.
; [[Legacy:LocationID|LocationID]] LocationID : This is a reference to the first item in the [[Legacy:Linked List|linked list]] of [[Legacy:LocationID|LocationID]]s in this zone.
; [[Legacy:SkyZoneInfo|SkyZoneInfo]] SkyZone : Optional sky zone containing this zone's sky.

==Methods ==

===Iterator Functions ===
; ZoneActors (class<[[Legacy:Actor|Actor]]> BaseClass, out [[Legacy:Actor|Actor]] Actor) : Iterates through all actors in this zone.

===Other Functions ===
; LinkToSkybox ( ) [simulated] : This function is called from <tt>PreBeginPlay</tt> and initialises the link to the Sky Zone for this zone. The [[Legacy:SkyZoneInfo|SkyZoneInfo]] object linked to is determined by the detail settings on the client machine (if there is more than one).

; ActorEntered ([[Legacy:Actor|Actor]] Other) : This event fires whenever an actor enters the zone. It is responsible for posting any event specified by the <tt>ZonePlayerEvent</tt> property by calling the <tt>Trigger</tt> function. The function also applies any zone physics to objects with physics of <tt>PHYS_Projectile</tt> or objects of type [[Legacy:Effects (UT)|Effects (UT)]].

; ActorLeaving ([[Legacy:Actor|Actor]] Other) : This event fires whenever an actor leaves the zone. It is responsible for posting any event specified by the <tt>ZonePlayerEvent</tt> property by calling the <tt>UnTrigger()</tt> function.

==Known Subclasses ==

Some of these merely differ from ZoneInfo by their default properties, for instance [[Legacy:WaterZone|WaterZone]]. Others, such as [[Legacy:PressureZone|PressureZone]] add new scripted behavior.
* [[Legacy:CloudZone|CloudZone]]
* [[Legacy:MCloudZone|MCloudZone]] (custom class; fixes CTF flag bug)
* CounterZone (custom: http://darendash.home.comcast.net/CounterZone.html )
* [[Legacy:DuckingZone|DuckingZone]] (DM-DuckingZone) (custom)
* [[Legacy:Jailbreak/Classes|JailZone]] ([[Legacy:Jailbreak|Jailbreak]])
* [[Legacy:Jailbreak/Classes|JBArenaZone]] ([[Legacy:Jailbreak|Jailbreak]])
* [[Legacy:Jumpzone|Jumpzone]] (custom)
* [[Legacy:KillingField|KillingField]]
* [[Legacy:LavaZone|LavaZone]]
* [[Legacy:LevelInfo|LevelInfo]]
* [[Legacy:NitrogenZone|NitrogenZone]]
* [[Legacy:PressureZone|PressureZone]]
* [[Legacy:SkyZoneInfo|SkyZoneInfo]]
* [[Legacy:SlimeZone|SlimeZone]]
* [[Legacy:TarZone|TarZone]]
* [[Legacy:TeleporterZone|TeleporterZone]]
* [[Legacy:VacuumZone|VacuumZone]]
* [[Legacy:WarpZoneInfo|WarpZoneInfo]]
* [[Legacy:WaterZone|WaterZone]]

==Related Topics ==
* [[Legacy:Iterator|Iterator]] functions

See [[Legacy:NoTransloc|NoTransloc]] for more details on making a zone non-translocatable.

==Comments ==

Might be worth mentioning that ZoneInfo has an iterator function; - ''Probably - not found an example of use yet, but then I've not looked.''

A thought: we could do a "Types of Zone" or something page.

'''EntropicLqd:''' Isn't that already covered within the general Zones page? It might be worth linking the example map from the general zone page as well thinking about it.

'''Tarquin:''' not sure. Zones / Zoning etc is on the list of topics that need refactoring. your idea sounds good to me.

'''Wormbo:''' Is there any reason, why we should give '''event''' methods a special heading in class descriptions like this one?

'''EntropicLqd:''' I did it to be consistent with the rest of the stuff I'd already done. Although the distinction between events and functions in UnrealScript is somewhat logical in nature it is a pleasant distinction.

'''Mychaeel:''' Besides, events are customarily used for engine notifications (as opposed to "called from somewhere else in the available UnrealScript code"). I think making that distinction has its benefits.

'''Evilmrfrank:''' What exactly is the reverb option for. I noticed that the zone info actor in frigate used this option. Just wondering if it offers any better quality sound or picture or what? Also one more thing, why are many of the lights in official maps invisible in the editor? IS there any purpose other then just keeping them out of the way or are they invisible for a good reason?

Legacy:Message Placeholder

2016-09-02T21:02:14Z

SeriousBarbie: Undo revision 46359 by SeriousBarbie (talk)

'''Message placeholders''' are special escape codes that insert data from the game into strings. The most common example of these is the death messages, that say, for example:
: ''The Great Zaganza got ripped into tiny pieces by Hortense.''

Of course, the [[Legacy:Unreal Engine|Unreal Engine]] doesn't store that string, since it doesn't know the players will be called "The Great Zaganza" and "Hortense". It stores the string
: ''%o got ripped into tiny pieces by %k''

The %o and %k are placeholders, and when the string is used, they will be replaced with meaningful content: in this case, the names of players.

==Death Messages in UT ==

These can be used in the DeathMessage variable in the [[Legacy:Weapon (UT)|Weapon (UT)]] class and as SpecialDamageString of the [[Legacy:GameInfo (UT)|GameInfo (UT)]] when using 'SpecialDamage' as damage type.

{|

|-
|'''Placeholder'''
|'''Description'''
|-
| style="text-align: center" |<code>%k</code>
|Killer's name
|-
| style="text-align: center" |<code>%w</code>
|Weapon the killer was holding while the other player died.
|-
| style="text-align: center" |<code>%o</code>
|Victim's name
|}

Each placeholder may only appear once.

===SpecialEvent ===

Custom death messages for [[Legacy:SpecialEvent|SpecialEvent]] only work in the '''KillInstigator''' [[Legacy:InitialState|InitialState]]. Set DamageType to 'SpecialDamage'.

Only <code>%o</code> is parsed but <code>%k</code> must be included for it to work, it will be removed with no replacement.

===ZoneInfo ===

Set DamageType to 'SpecialDamage'. <code>%k</code> must be included, otherwise the death message will be blank in the game.

''They DO work without'' <code>%o</code>'', but it doesn't look nice. -GeniusDex''

===Zones using death messages ===
* [[Legacy:ZoneInfo|ZoneInfo]]
** [[Legacy:PressureZone|PressureZone]]
** [[Legacy:LavaZone|LavaZone]]
** [[Legacy:SlimeZone|SlimeZone]]

''The noted types of ZoneInfos are only examples, as far as i know every ZoneInfo can be killing. -GeniusDex''

''Please add other triggers and zones that use death messages.''

===Related UT Topics ===
* [[Legacy:Weapon (UT)|Weapon (UT)]]
* [[Legacy:ScrollingMessageTexture|ScrollingMessageTexture]]
* [[Legacy:GameInfo (UT)|GameInfo (UT)]]
* [[Legacy:Taking Damage|Taking Damage]]

==Placeholders in UT2003 ==

In UT2003 only the placeholders %k (killer) and %o (victim) are used in death messages.

However, there are several placeholders usable in TeamSay messages. They only work in team games and only with the TeamSay, not the Say command. The placeholders are not case-sensitive.

{|

|-
|'''Placeholder'''
|'''Description'''
|-
| style="text-align: center" |<code>%A</code>
|amount of adrenaline ("xx Adrenaline")
|-
| style="text-align: center" |<code>%H</code>
|amount of health ("xx Health")
|-
| style="text-align: center" |<code>%L</code>
|current location (near game objectives or "pickups with inventory items on a pickup base", i.e. usually weapons, but not health, shield or double damage)
|-
| style="text-align: center" |<code>%S</code>
|amount of shield ("xx Shield")
|-
| style="text-align: center" |<code>%W</code>
|currently selected weapon
|-
| style="text-align: center" |<code>%%</code>
|the "%" character (used e.g. as "%%w" to display "%w" instead of the weapon name)
|}

With the TTM 2003 mod there are also "%P" and "%G" ("pickups" and "guns") to display nearby (non-)weapon pickups. Mods can add their own variables from their [[Legacy:Mutator|Mutator]], [[Legacy:GameInfo|GameInfo]] and/or [[Legacy:Controller|Controller]] classes via the <code>ParseChatPercVar()</code> function.

===Related UT2003 Topics ===
* [[Legacy:Controller|Controller]]
* [[Legacy:GameInfo|GameInfo]]
* [[Legacy:Mutator|Mutator]]

Legacy:Message Placeholder

2016-09-02T21:00:58Z

SeriousBarbie: created anchor

'''Message placeholders''' are special escape codes that insert data from the game into strings. The most common example of these is the death messages, that say, for example:
: ''The Great Zaganza got ripped into tiny pieces by Hortense.''

Of course, the [[Legacy:Unreal Engine|Unreal Engine]] doesn't store that string, since it doesn't know the players will be called "The Great Zaganza" and "Hortense". It stores the string
: ''%o got ripped into tiny pieces by %k''

The %o and %k are placeholders, and when the string is used, they will be replaced with meaningful content: in this case, the names of players.

==Death Messages in UT ==

These can be used in the DeathMessage variable in the [[Legacy:Weapon (UT)|Weapon (UT)]] class and as SpecialDamageString of the [[Legacy:GameInfo (UT)|GameInfo (UT)]] when using 'SpecialDamage' as damage type.

{|

|-
|'''Placeholder'''
|'''Description'''
|-
| style="text-align: center" |<code>%k</code>
|Killer's name
|-
| style="text-align: center" |<code>%w</code>
|Weapon the killer was holding while the other player died.
|-
| style="text-align: center" |<code>%o</code>
|Victim's name
|}

Each placeholder may only appear once.

===SpecialEvent ===

Custom death messages for [[Legacy:SpecialEvent|SpecialEvent]] only work in the '''KillInstigator''' [[Legacy:InitialState|InitialState]]. Set DamageType to 'SpecialDamage'.

Only <code>%o</code> is parsed but <code>%k</code> must be included for it to work, it will be removed with no replacement.

=== ZoneInfo ===

Set DamageType to 'SpecialDamage'. <code>%k</code> must be included, otherwise the death message will be blank in the game.

''They DO work without'' <code>%o</code>'', but it doesn't look nice. -GeniusDex''

===Zones using death messages ===
* [[Legacy:ZoneInfo|ZoneInfo]]
** [[Legacy:PressureZone|PressureZone]]
** [[Legacy:LavaZone|LavaZone]]
** [[Legacy:SlimeZone|SlimeZone]]

''The noted types of ZoneInfos are only examples, as far as i know every ZoneInfo can be killing. -GeniusDex''

''Please add other triggers and zones that use death messages.''

===Related UT Topics ===
* [[Legacy:Weapon (UT)|Weapon (UT)]]
* [[Legacy:ScrollingMessageTexture|ScrollingMessageTexture]]
* [[Legacy:GameInfo (UT)|GameInfo (UT)]]
* [[Legacy:Taking Damage|Taking Damage]]

==Placeholders in UT2003 ==

In UT2003 only the placeholders %k (killer) and %o (victim) are used in death messages.

However, there are several placeholders usable in TeamSay messages. They only work in team games and only with the TeamSay, not the Say command. The placeholders are not case-sensitive.

{|

|-
|'''Placeholder'''
|'''Description'''
|-
| style="text-align: center" |<code>%A</code>
|amount of adrenaline ("xx Adrenaline")
|-
| style="text-align: center" |<code>%H</code>
|amount of health ("xx Health")
|-
| style="text-align: center" |<code>%L</code>
|current location (near game objectives or "pickups with inventory items on a pickup base", i.e. usually weapons, but not health, shield or double damage)
|-
| style="text-align: center" |<code>%S</code>
|amount of shield ("xx Shield")
|-
| style="text-align: center" |<code>%W</code>
|currently selected weapon
|-
| style="text-align: center" |<code>%%</code>
|the "%" character (used e.g. as "%%w" to display "%w" instead of the weapon name)
|}

With the TTM 2003 mod there are also "%P" and "%G" ("pickups" and "guns") to display nearby (non-)weapon pickups. Mods can add their own variables from their [[Legacy:Mutator|Mutator]], [[Legacy:GameInfo|GameInfo]] and/or [[Legacy:Controller|Controller]] classes via the <code>ParseChatPercVar()</code> function.

===Related UT2003 Topics ===
* [[Legacy:Controller|Controller]]
* [[Legacy:GameInfo|GameInfo]]
* [[Legacy:Mutator|Mutator]]

Compiler directives

2016-09-02T19:05:47Z

SeriousBarbie: "include" does not work with UE1 - moved to UE2 (I hope that it works there...)

'''Compiler directives''' are lines in [[UnrealScript]] source files that affect compiler behavior and have no meaning at runtime. They are not really used anymore in [[Unreal Engine 3]], which comes with a powerful [[preprocessor]] instead.

Directives are parsed during the compile process, not before that. This means they cannot be used in [[defaultproperties]] or [[cpptext]] sections. In fact, any directives in cpptext blocks will end up in exported header files for preprocessing by the C++ compiler.

==Syntax==
Compiler directives must be placed on a separate line. The syntax is as follows:
'''#'''''directivename'' ''parameters''
There must not be anything else before the '''#''' on that line and there shouldn't be anything after the directive name and parameters, except maybe a line comment. Directive names are case-insensitive, like any other part of UnrealScript syntax.

==Unreal Engine 1/2==
===call===
Similar to the "exec" console command in the editor and the game. Loads a list of console commands from a text file and executes them.

See [[exec commands]] for a useful selection of commands.

===error===
Immediately stops compiling with the message: "#Error directive encountered"

Note that there is no built-in conditional compiling, so using this directive may be quite pointless without an external preprocessor tool like [[UCPP]].

===exec===
The most-used directive and probably the only one most UnrealScript programmers ever need to use. The '''#exec''' directive executes an editor console command in the context of the compiler.

See [[exec commands]] for a useful selection of commands.

==Unreal Engine 2==

===include===
Loads a text file and replaces the #include line with its content.

There are several things to watch out for when using this directive:
* Line numbers reported in errors and warnings after the #include line will reflect the source text with the included content, so they no longer match the original source line numbers.
* If the included file contains a [[defaultproperties]] block, it is not included directly. Instead, its content is inserted into the class's defaultproperties block.

==Unreal Engine 3==
The only known directive in Unreal Engine 3 is '''#linenumber''', which is inserted by the preprocessor after an '''`include''' macro to make sure the compiler reports the line numbers the user expects.

{{navbox unrealscript}}

Legacy:T3D File

2016-08-31T18:46:59Z

SeriousBarbie: link fix

Legacy:TriggeredTexture

2016-08-31T17:57:46Z

SeriousBarbie: +Legacy:Dynamic_Texture/+cat

{{classbox|[[Legacy:Actor|Actor]] >> [[Legacy:Triggers (UT)|Triggers (UT)]] >> TriggeredTexture}}

'''TriggeredTexture''' controls a [[Legacy:ScriptedTexture (UT)|ScriptedTexture (UT)]] and allows you to switch between different textures displayed on a [[Legacy:Brush|brush]] surface. Used, for instance, for the monitors in in AS-OceanFloor that initially display "Computer online" and switch to "Computer offline" as soon as a terminal has been destroyed.

==Properties ==

; DestinationTexture : The [[Legacy:ScriptedTexture (UT)|ScriptedTexture (UT)]] controlled by this TriggeredTexture actor. Note that although this property accepts a regular texture, the TriggeredTexture won't work if you don't really use a ScriptedTexture.

; Textures : List of regular [[Legacy:Texture (UT)|Texture (UT)]]s that the TriggeredTexture will cycle through when triggered. Initially, the Texture in slot 0 (zero) is displayed; each time you trigger the TriggeredTexture, the display advances to the next slot. The first slot containing ''None'' marks the end of the list.

; bTriggerOnceOnly : If set, goes through the list only once (rather than switching back to the first slot after the last has been reached).

==How To Use ==

# Apply a [[Legacy:ScriptedTexture (UT)|ScriptedTexture (UT)]] (for instance Monitor1 to Monitor8 from <tt>Indus7.utx</tt>) wherever you want the dynamic texture to appear. (It will look blank in UnrealEd.)
# Place a TriggeredTexture actor somewhere in your map.
# Open the TriggeredTexture's properties and set its DestinationTexture property to the ScriptedTexture you used in the first step.
# Fill the Textures slots with the textures you want to display on the ScriptedTexture.
# Add a [[Legacy:Trigger|Trigger]] that triggers the TriggeredTexture whenever the displayed texture should change. (To link the Trigger and the TriggeredTexture, set the Trigger's Event property to the same value as the TriggeredTexture's Tag property.)

Note that the color palette isn't changed. So if your textures doesn't share the same palette, or have identical palettes(?), the other texture's colors will be messed up.

==Related Pages ==

* [[Legacy:Screen|Screen]] – Provides more control over ScriptedTextures than just cycling through regular textures
* [[Legacy:Dynamic_Texture|Dynamic Texture]]

[[Category:Legacy Mapping|{{PAGENAME}}]]

Legacy:FortStandard

2016-08-13T02:58:40Z

SeriousBarbie: hint to other game types

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Pawn (UT)|Pawn (UT)]] >> [[Legacy:StationaryPawn|StationaryPawn]] >> FortStandard}}

This actor marks objectives in an Assault type map. See [[Legacy:Mapping For AS (UT)|Mapping For AS (UT)]]. If game type is not Assault, this actor destroys itself before game starts.

You need to make this in your assault levels to make them work.

To make the time limit for your assault level you need to open the last FortStandard's properties and select defense time and put what ever you want the time limit to be for your level.

You will need to plan and build your level before using this actor. Once you have built your level place a FortStandard VERY CLOSE to the objective, as there are two ways to trigger this actor: damage and touch. First a list of all the actor specific variables you will need to be familiar with:

==Properties ==
; bFinalFort : When this objective has been triggered, the mission will end.
; bFlashing : When damage is taken, the fort standard will flash. Not sure what the damage threshold for this is.
; bForceRadius : If true, bots will charge when they are within a specified radius.
; bSayDestroyed : Bots will use a voicepack recording if they have accomplished this objective.
; bSelfDisplayed : If true, the fort standard will be visible as a small flag in game. Almost always set false.
; bTriggerOnly : Set to true if you want the objective to be triggered by touch instead of damage.
; ChargeDist : This is the distance from which bots will begin charging if bForceRadius is set true.
; DamageEvent : This has several slots for calling multiple events. Similar to a [[Legacy:Dispatcher|Dispatcher]].
; DmgEventThreshold : The amount of damage that is needed to trigger DamageEvent. Different damage amounts can be set for different events.
; DefensePriority : In which order bots should defend the objectives. The higher the number, the higher the Priority. I have no idea if there is a limit to the amount of objectives, or how big a number to put here. I do know that you can only place seven objectives in the [[Legacy:AssaultInfo|AssaultInfo]] actor. (Explained later)
; DefenseTime : Simply the amount of time in minutes that players have to complete the level. The default value is ten, meaning ten minutes. But I have found out by fiddling that if you have different values in this field for each FortStandard, the engine will take the highest value as the intended game time limit
; DestroyedMessage : This is the message to be shown when objective is destroyed. Used in combination with the FortName value.
; EndCamTag : Tag of the [[Legacy:SpectatorCam|SpectatorCam]] you are using as an end camera. I do not know if each standard needs this or if it is only the final.
; FallBackFort : The tag of the fort which defenders should fall back to. I would recommend leaving this blank, and utilizing the DefensePriority property to indicate for the bots where to go.
; FortName : Name of the objective. Will be shown with the destroyed message.
; NearestPathNodeTag : The Tag of the nearest [[Legacy:PathNode|PathNode]] looking in the direction of the attackers (see [[Legacy:Match These Tags|Match These Tags]] for more information). Bots should reach this node ''before'' they reach the FortStandard.

==Discussion ==

[[Legacy:SabbathCat|SabbathCat]] : Hey Mango, nice work collating. Hope you stick around a while to add some more, definitely a pro already with WIKI mark-up. I added the pathnode tag thing. As observed from a fair few AS maps from Epic. :)

'''Tarquin:''' Nice stuff, but should maybe be moved to [[Legacy:Mapping For AS (UT)|Mapping For AS (UT)]]? :)

'''King Mango:''' Yup will do. New here, but am getting the hang of the method. Thanks guys :D!!

'''Tarquin:''' the props list says set DefenseTime to the same value for each one, but the top paragraphs say you only need to set it for the final Standard. Which is true?

'''MythOpus:''' I believe you only have to set the time in the AssaultInfo... or at least, thats how I remember it. I'ts been so long O_o

'''King Mango''' I have found out by experimentation regarding the correct info for DefenseTime. Page reflects changes.

'''SabbathKatze:''' Do the Damage Events actually work? I've tried linking them to both a Movers Tag and Event, and neither seems to fire them off. :S?

'''King Mango''' My apologies, I misinformed as to defense priority. It has been fixed. Couldn't figure out why my bots kept trying to attack and defend from the second objective as I was playtesting. Then changed the values, and batta-boom, batta-bing, they are working fine.

'''xX)(Xx'''

Also, fortstandards in Assault maps are affected by ZEROPING weapons, the zeroping weapons just can't hit the fortstandards, it would be great to know why, see

http://wiki.beyondunreal.com/wiki/Lag_Compensation

for more info on ZeroPing

'''tarnationsauce2''' It seems FortStandards are hard coded at a maximum of 16 (0-15).

[[Category:Legacy Class (UT)|{{PAGENAME}}]]

Legacy:Color Blending

2016-08-12T23:11:19Z

SeriousBarbie: even more anchors, wikified

'''Color blending''' modes (or rendering modes) specify how the color of an individual [[Legacy:Texture|texture]] pixel is merged with the color of the corresponding background pixel it is going to be drawn on.

==Color Blending Modes==

;None: Graphics are not drawn.

;Normal: Every pixel is 100% opaque. If you #EXEC IMPORT it with FLAGS=2, then every pixel that uses the first entry in the pallette will be 100% transparent and the rest will be 100% opaque.

;Masked: The first pixel in the [[Legacy:Palette|palette]] is 100% transparent; all others are 100% opaque. There is a utility called "[[Legacy:Bright|Bright]]" distributed by Epic, that helps with this. It has a command line option "-pinkmask" that makes all pink pixels (R=255, G=0, B=255) transparent, and all others opaque. In UT2003 this will only work with 8bit textures.
;Translucent: The brightness of the color determines it's opacity. i.e.
;* white is 100% opaque
;* a middle bright colour such as grey or medium yellow is partially transparent
;* black is 100% translucent
;:This doesn't work well in some configurations (possibly MacOS + Glide) unless the <tt>#EXEC IMPORT</tt> also has <tt>FLAGS=2</tt>. If you plan to draw <tt>STY_Translucent</tt>, always use <tt>FLAGS=2</tt>.
;Modulated: Multiplies the destination pixels by the source if the source is darker than 127,127,127. Screens the destination pixels if the source is brighter than 127,127,127. (like the Photoshop "Overlay" mode). This results in:
;* color 0,0,0 = darken whatever is behind it
;* color 127,127,127 = no change
;* color 255, 255, 255 = brighten whatever is behind it

=== Additional modes in new engine versions (e.g. UT2003) ===

;Alpha: Uses an [[Legacy:Alpha Channel|alpha channel]] to determine the translucency of the texture's pixels.

;Additive: Adds the color in the source pixels to the background. A red pixel painted onto a blue background will result in a purple pixel being shown. Additive differs from translucent in that translucent actors will can stack up on the screen and become more opaque, where additive actors will not. For example, if you had 100 red translucent clouds in a row, they would stack up and you would see just red if you looked through all of them at once. If it were additive clouds, they would add their red to the background but stop adding when the red was maxed out (R=255) so you could still see what was behind.

;Subtractive: This is essentially the same as additive, but the source pixels color is subtracted from the background. This is not that useful of a drawtype, but it does have a strong application in making smoke (bluish-white particles set to subtractive make a nice brownish-black color.)

; Particle: Only used for [[Legacy:Emitter|Emitter]]s. This causes the Emitter to draw its particles.

; AlphaZ: ''what does this do?''

Opaque is the opposite of translucent; you can't see through something opaque. If it's 75% opaque (or 25% translucent), it's slightly transparent; you can see through it a slightly. 0% opaque is 100% translucent; it's invisible and not drawn.

<tt>#EXEC IMPORT with FLAGS=2</tt> is the same as having the texture property flag bTranslucent set within Ued/2. This makes first colour in the palette 100% transparent.

==Usage==

These rendering modes can apply to:

===Canvas===

In [[Legacy:UnrealScript|UnrealScript]], set <tt>[[Legacy:Canvas|Canvas]].Style</tt>.

===Actor===

For [[Legacy:Actor|Actor]]s, use Display -> Style

==Styles ==

Declared as an enum in the Actor class.

===UT===

<uscript>
// Style for rendering sprites, meshes.

var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
} Style;
</uscript>

===UT2003===

<uscript>
// Style for rendering sprites, meshes.
var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
STY_Alpha,
STY_Additive,
STY_Subtractive,
STY_Particle,
STY_AlphaZ,
} Style;
</uscript>

==Related Topics==
* See [[Legacy:Unreal Coding FAQ|Unreal Coding FAQ]] for more information
[[Category:Legacy Mapping|{{PAGENAME}}]]
[[Category:Legacy To Do|{{PAGENAME}}]]

Legacy:PolyFlags

2016-08-12T23:07:07Z

SeriousBarbie: enhanced

In the properties of a [[Legacy:Brush|Brush]], under ''Brush -> PolyFlags'' you can give all surfaces of the brush default properties that override the [[Legacy:Surface Flags (UT)|Surface Flags (UT)]] in the [[Legacy:Surface Properties Window|Surface Properties window]].

In ''PolyFlags'' you have to enter a decimal number, what follows is a list of the meaning of all the numbers.

To give a brush two or more properties at the same time, you need to make the sum of the numbers of both properties. For example if you want a Translucent + TwoSided brush, you have to use the number 4 + 256 = 260.

After you entered the number you need to rebuild to see the change.

Here's the list, mostly taken from ''Enum-Polyflags.h'':

{|class="wikitable"
!Bit
!Value (dec)
!Value (hex)
!Name
!Description
|- style="background-color: lightgray"
|
|style="text-align: right"|0
|style="text-align: right"|0x0
|
|Use settings from Surface Properties for each individual surface of the brush.
|-
|style="text-align: right"|0
|style="text-align: right"|1
|style="text-align: right"|0x1
|PF_Invisible
|Polygon is invisible.
|- style="background-color: lightgray"
|style="text-align: right"|1
|style="text-align: right"|2
|style="text-align: right"|0x2
|PF_Masked
|Polygon should be drawn masked. Use for palettized textures to make the first color in the palette (in Paint Shop Pro at least) invisible, see [[Legacy:Color Blending#masked|Color Blending]].
|-
|style="text-align: right"|2
|style="text-align: right"|4
|style="text-align: right"|0x4
|PF_Translucent
|Darker parts of the texture become transparent, see [[Legacy:Color Blending#translucent|Color Blending]].
|- style="background-color: lightgray"
|style="text-align: right"|3
|style="text-align: right"|8
|style="text-align: right"|0x8
|PF_NotSolid
|Polygon is not solid doesn't block.
|-
|style="text-align: right"|4
|style="text-align: right"|16
|style="text-align: right"|0x10
|PF_Environment
|Polygon should be drawn environment mapped.
|-
|style="text-align: right"|4
|style="text-align: right"|16
|style="text-align: right"|0x10
|PF_ForceViewZone
|Force current iViewZone in OccludeBSP (reuse Environment flag).
|- style="background-color: lightgray"
|style="text-align: right"|5
|style="text-align: right"|32
|style="text-align: right"|0x20
|PF_Semisolid
|Polygon is semi-solid, collision solid CSG nonsolid.
|-
|style="text-align: right"|6
|style="text-align: right"|64
|style="text-align: right"|0x40
|PF_Modulated
|Greyer parts of the texture become transparent, see [[Legacy:Color Blending#modulated|Color Blending]].
|- style="background-color: lightgray"
|style="text-align: right"|7
|style="text-align: right"|128
|style="text-align: right"|0x80
|PF_FakeBackdrop
|Poly looks exactly like backdrop (parallax SkyBox visible through surface).
|-
|style="text-align: right"|8
|style="text-align: right"|256
|style="text-align: right"|0x100
|PF_TwoSided
|Poly is visible from both sides.
|- style="background-color: lightgray"
|style="text-align: right"|9
|style="text-align: right"|512
|style="text-align: right"|0x200
|PF_AutoUPan
|Automatically pans in U direction; change speed in [[Legacy:ZoneInfo|ZoneInfo]] or [[Legacy:LevelInfo|LevelInfo]] -> ZoneLight.
|-
|style="text-align: right"|10
|style="text-align: right"|1024
|style="text-align: right"|0x400
|PF_AutoVPan
|Automatically pans in V direction; change speed in [[Legacy:ZoneInfo|ZoneInfo]] or [[Legacy:LevelInfo|LevelInfo]] -> ZoneLight.
|- style="background-color: lightgray"
|style="text-align: right"|11
|style="text-align: right"|2048
|style="text-align: right"|0x800
|PF_NoSmooth
|Don't smooth textures.
|-
|style="text-align: right"|12
|style="text-align: right"|4096
|style="text-align: right"|0x1000
|PF_BigWavy
|Poly has a big wavy pattern in it.
|-
|style="text-align: right"|12
|style="text-align: right"|4096
|style="text-align: right"|0x1000
|PF_SpecialPoly
|Game-specific poly-level render control (reuse BigWavy flag).
|- style="background-color: lightgray"
|style="text-align: right"|13
|style="text-align: right"|8192
|style="text-align: right"|0x2000
|PF_SmallWavy
|Small wavy pattern (for water/enviro reflection).
|-
|style="text-align: right"|14
|style="text-align: right"|16384
|style="text-align: right"|0x4000
|PF_Flat
|Flat surface.
|- style="background-color: lightgray"
|style="text-align: right"|15
|style="text-align: right"|32768
|style="text-align: right"|0x8000
|PF_LowShadowDetail
|Reduces shadow detail; in conjunction with High Shadow Detail (below), makes extra low shadow detail
|-
|style="text-align: right"|16
|style="text-align: right"|65536
|style="text-align: right"|0x10000
|PF_NoMerge
|Don't merge poly's nodes before lighting when rendering.
|- style="background-color: lightgray"
|style="text-align: right"|17
|style="text-align: right"|131072
|style="text-align: right"|0x20000
|PF_CloudWavy
|Polygon appears wavy like clouds.
|-
|style="text-align: right"|18
|style="text-align: right"|262144
|style="text-align: right"|0x40000
|PF_DirtyShadows
|Dirty shadows.
|- style="background-color: lightgray"
|style="text-align: right"|19
|style="text-align: right"|524288
|style="text-align: right"|0x80000
|PF_BrightCorners
|Brighten convex corners; no dark shadows at the edges of the surface.
|-
|style="text-align: right"|20
|style="text-align: right"|1048576
|style="text-align: right"|0x100000
|PF_SpecialLit
|Surface only gets light from [[Legacy:Special Lit|Special Lit]] lights.
|- style="background-color: lightgray"
|style="text-align: right"|21
|style="text-align: right"|2097152
|style="text-align: right"|0x200000
|PF_Gouraud
|Gouraud shaded.
|- style="background-color: lightgray"
|style="text-align: right"|21
|style="text-align: right"|2097152
|style="text-align: right"|0x200000
|PF_NoBoundRejection
|Disable bound rejection in OccludeBSP (reuse Gourard flag).
|-
|style="text-align: right"|22
|style="text-align: right"|4194304
|style="text-align: right"|0x400000
|PF_Unlit
|Surface ignores lighting and is full bright.
|- style="background-color: lightgray"
|style="text-align: right"|23
|style="text-align: right"|8388608
|style="text-align: right"|0x800000
|PF_HighShadowDetail
|Enhances shadow detail.
|-
|style="text-align: right"|24
|style="text-align: right"|16777216
|style="text-align: right"|0x1000000
|PF_Memorized
|Editor: Poly is remembered.
|-
|style="text-align: right"|24
|style="text-align: right"|16777216
|style="text-align: right"|0x1000000
|PF_RenderHint
|Internal: Rendering optimization hint.
|- style="background-color: lightgray"
|style="text-align: right"|25
|style="text-align: right"|33554432
|style="text-align: right"|0x2000000
|PF_Selected
|Editor: Poly is selected.
|-
|style="text-align: right"|26
|style="text-align: right"|67108864
|style="text-align: right"|0x4000000
|PF_Portal
|Portal between iZones.
|- style="background-color: lightgray"
|style="text-align: right"|27
|style="text-align: right"|134217728
|style="text-align: right"|0x8000000
|PF_Mirrored
|Reflective surface.
|-
|style="text-align: right"|28
|style="text-align: right"|268435456
|style="text-align: right"|0x10000000
|PF_Highlighted
|Editor: Poly is highlighted.
|- style="background-color: lightgray"
|style="text-align: right"|29
|style="text-align: right"|536870912
|style="text-align: right"|0x20000000
|
|(unused?)
|-
|style="text-align: right"|30
|style="text-align: right"|1073741824
|style="text-align: right"|0x40000000
|PF_FlatShaded
|FPoly has been split by SplitPolyWithPlane.
|-
|style="text-align: right"|30
|style="text-align: right"|1073741824
|style="text-align: right"|0x40000000
|PF_EdProcessed
|Internal: FPoly was already processed in editorBuildFPolys.
|-
|style="text-align: right"|30
|style="text-align: right"|1073741824
|style="text-align: right"|0x40000000
|PF_RenderFog
|Internal: Render with fogmapping.
|- style="background-color: lightgray"
|style="text-align: right"|31
|style="text-align: right"|2147483648
|style="text-align: right"|0x80000000
|PF_EdCut
|Internal: FPoly has been split by SplitPolyWithPlane.
|- style="background-color: lightgray"
|style="text-align: right"|31
|style="text-align: right"|2147483648
|style="text-align: right"|0x80000000
|PF_Occlude
|Internal: Occludes even if PF_NoOcclude.
|}

== Named combinations of flags ==
{|
|-
| PF_NoOcclude = || PF_Masked {{!}} PF_Translucent {{!}} PF_Invisible {{!}} PF_Modulated
|-
| PF_NoEdit = || PF_Memorized {{!}} PF_Selected {{!}} PF_EdProcessed {{!}} PF_NoMerge {{!}} PF_EdCut
|-
| PF_NoImport = || PF_NoEdit {{!}} PF_NoMerge {{!}} PF_Memorized {{!}} PF_Selected {{!}} PF_EdProcessed {{!}} PF_EdCut
|-
| PF_AddLast = || PF_Semisolid {{!}} PF_NotSolid
|-
| PF_NoAddToBSP = || PF_EdCut {{!}} PF_EdProcessed {{!}} PF_Selected {{!}} PF_Memorized
|-
| PF_NoShadows = || PF_Unlit {{!}} PF_Invisible {{!}} PF_Environment {{!}} PF_FakeBackdrop
|-
| PF_Transient = || PF_Highlighted
|}

[[Category:Legacy Mapping|{{PAGENAME}}]]

Legacy:Masked Texture

2016-08-12T20:59:04Z

SeriousBarbie: Redirected page to Legacy:Color Blending#masked

#REDIRECT [[Legacy:Color_Blending#masked]]

Legacy:Color Blending

2016-08-12T20:56:38Z

SeriousBarbie: moved anchor

'''Color blending''' modes (or rendering modes) specify how the color of an individual [[Legacy:Texture|texture]] pixel is merged with the color of the corresponding background pixel it is going to be drawn on.

==Color Blending Modes==

;None: Graphics are not drawn.

;Normal: Every pixel is 100% opaque. If you #EXEC IMPORT it with FLAGS=2, then every pixel that uses the first entry in the pallette will be 100% transparent and the rest will be 100% opaque.

;Masked: The first pixel in the [[Legacy:Palette|palette]] is 100% transparent; all others are 100% opaque.

There is a utility called "[[Legacy:Bright|Bright]]" distributed by Epic, that helps with this. It has a command line option "-pinkmask" that makes all pink pixels (R=255, G=0, B=255) transparent, and all others opaque.

In UT2003 this will only work with 8bit textures.

;Translucent: The brightness of the color determines it's opacity. i.e.
;* white is 100% opaque
;* a middle bright colour such as grey or medium yellow is partially transparent
;* black is 100% translucent
;:This doesn't work well in some configurations (possibly MacOS + Glide) unless the <tt>#EXEC IMPORT</tt> also has <tt>FLAGS=2</tt>. If you plan to draw <tt>STY_Translucent</tt>, always use <tt>FLAGS=2</tt>.

;Modulated: Multiplies the destination pixels by the source if the source is darker than 127,127,127. Screens the destination pixels if the source is brighter than 127,127,127. (like the Photoshop "Overlay" mode). This results in:
;* color 0,0,0 = darken whatever is behind it
;* color 127,127,127 = no change
;* color 255, 255, 255 = brighten whatever is behind it

Additional modes in new engine versions (e.g. UT2003):

;Alpha: Uses an [[Legacy:Alpha Channel|alpha channel]] to determine the translucency of the texture's pixels.

;Additive: Adds the color in the source pixels to the background. A red pixel painted onto a blue background will result in a purple pixel being shown. Additive differs from translucent in that translucent actors will can stack up on the screen and become more opaque, where additive actors will not. For example, if you had 100 red translucent clouds in a row, they would stack up and you would see just red if you looked through all of them at once. If it were additive clouds, they would add their red to the background but stop adding when the red was maxed out (R=255) so you could still see what was behind.

;Subtractive: This is essentially the same as additive, but the source pixels color is subtracted from the background. This is not that useful of a drawtype, but it does have a strong application in making smoke (bluish-white particles set to subtractive make a nice brownish-black color.)

; Particle: Only used for [[Legacy:Emitter|Emitter]]s. This causes the Emitter to draw its particles.

; AlphaZ: ''what does this do?''

Opaque is the opposite of translucent; you can't see through something opaque. If it's 75% opaque (or 25% translucent), it's slightly transparent; you can see through it a slightly. 0% opaque is 100% translucent; it's invisible and not drawn.

<tt>#EXEC IMPORT with FLAGS=2</tt> is the same as having the texture property flag bTranslucent set within Ued/2. This makes first colour in the palette 100% transparent.

==Usage==

These rendering modes can apply to:

===Canvas===

In [[Legacy:UnrealScript|UnrealScript]], set <tt>[[Legacy:Canvas|Canvas]].Style</tt>.

===Actor===

For [[Legacy:Actor|Actor]]s, use Display -> Style

==Styles ==

Declared as an enum in the Actor class.

===UT===

<uscript>
// Style for rendering sprites, meshes.

var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
} Style;
</uscript>

===UT2003===

<uscript>
// Style for rendering sprites, meshes.
var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
STY_Alpha,
STY_Additive,
STY_Subtractive,
STY_Particle,
STY_AlphaZ,
} Style;
</uscript>

==Related Topics==
* See [[Legacy:Unreal Coding FAQ|Unreal Coding FAQ]] for more information
[[Category:Legacy Mapping|{{PAGENAME}}]]
[[Category:Legacy To Do|{{PAGENAME}}]]

Legacy:Color Blending

2016-08-12T20:55:21Z

SeriousBarbie: added anchor

'''Color blending''' modes (or rendering modes) specify how the color of an individual [[Legacy:Texture|texture]] pixel is merged with the color of the corresponding background pixel it is going to be drawn on.

==Color Blending Modes==

;None: Graphics are not drawn.

;Normal: Every pixel is 100% opaque. If you #EXEC IMPORT it with FLAGS=2, then every pixel that uses the first entry in the pallette will be 100% transparent and the rest will be 100% opaque.

;Masked: The first pixel in the [[Legacy:Palette|palette]] is 100% transparent; all others are 100% opaque.

There is a utility called "[[Legacy:Bright|Bright]]" distributed by Epic, that helps with this. It has a command line option "-pinkmask" that makes all pink pixels (R=255, G=0, B=255) transparent, and all others opaque.

In UT2003 this will only work with 8bit textures.

;Translucent: The brightness of the color determines it's opacity. i.e.
;* white is 100% opaque
;* a middle bright colour such as grey or medium yellow is partially transparent
;* black is 100% translucent
;:This doesn't work well in some configurations (possibly MacOS + Glide) unless the <tt>#EXEC IMPORT</tt> also has <tt>FLAGS=2</tt>. If you plan to draw <tt>STY_Translucent</tt>, always use <tt>FLAGS=2</tt>.

;Modulated: Multiplies the destination pixels by the source if the source is darker than 127,127,127. Screens the destination pixels if the source is brighter than 127,127,127. (like the Photoshop "Overlay" mode). This results in:
;* color 0,0,0 = darken whatever is behind it
;* color 127,127,127 = no change
;* color 255, 255, 255 = brighten whatever is behind it

Additional modes in new engine versions (e.g. UT2003):

;Alpha: Uses an [[Legacy:Alpha Channel|alpha channel]] to determine the translucency of the texture's pixels.

;Additive: Adds the color in the source pixels to the background. A red pixel painted onto a blue background will result in a purple pixel being shown. Additive differs from translucent in that translucent actors will can stack up on the screen and become more opaque, where additive actors will not. For example, if you had 100 red translucent clouds in a row, they would stack up and you would see just red if you looked through all of them at once. If it were additive clouds, they would add their red to the background but stop adding when the red was maxed out (R=255) so you could still see what was behind.

;Subtractive: This is essentially the same as additive, but the source pixels color is subtracted from the background. This is not that useful of a drawtype, but it does have a strong application in making smoke (bluish-white particles set to subtractive make a nice brownish-black color.)

; Particle: Only used for [[Legacy:Emitter|Emitter]]s. This causes the Emitter to draw its particles.

; AlphaZ: ''what does this do?''

Opaque is the opposite of translucent; you can't see through something opaque. If it's 75% opaque (or 25% translucent), it's slightly transparent; you can see through it a slightly. 0% opaque is 100% translucent; it's invisible and not drawn.

<tt>#EXEC IMPORT with FLAGS=2</tt> is the same as having the texture property flag bTranslucent set within Ued/2. This makes first colour in the palette 100% transparent.

==Usage==

These rendering modes can apply to:

===Canvas===

In [[Legacy:UnrealScript|UnrealScript]], set <tt>[[Legacy:Canvas|Canvas]].Style</tt>.

===Actor===

For [[Legacy:Actor|Actor]]s, use Display -> Style

==Styles ==

Declared as an enum in the Actor class.

===UT===

<uscript>
// Style for rendering sprites, meshes.

var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
} Style;
</uscript>

===UT2003===

<uscript>
// Style for rendering sprites, meshes.
var(Display) enum ERenderStyle
{
STY_None,
STY_Normal,
STY_Masked,
STY_Translucent,
STY_Modulated,
STY_Alpha,
STY_Additive,
STY_Subtractive,
STY_Particle,
STY_AlphaZ,
} Style;
</uscript>

==Related Topics==
* See [[Legacy:Unreal Coding FAQ|Unreal Coding FAQ]] for more information
[[Category:Legacy Mapping|{{PAGENAME}}]]
[[Category:Legacy To Do|{{PAGENAME}}]]

Legacy:T3D File

2016-08-12T01:11:53Z

SeriousBarbie: /* Related Topics */

The '''T3D file format''' or '''Unreal Text File''' holds a text list of Unreal map objects. An entire map can be saved as this file format, or just a single actor or brush.

Note that while brushes, their applied textures and light actors are saved, the [[Legacy:Unreal Geometry|Unreal Geometry]] itself is not saved: upon importing a T3D file the map must be built.

Copying objects from UnrealEd and pasting into a text editor produces the same format.

Unreal Text format

Exported brushes and (other) actors. See [[Legacy:T3D File|T3D file]].
* Created by:
** UnrealEd's File -> Import command
** UnrealEd's Brush -> Import command (see [[Legacy:Data Import And Export|Data Import and Export]] for more on both these commands).
** is this created by external stuff too?

===Exporting T3D ===
* Export the whole map
** File -> Export... (UnrealEd 1,2,3)
** File -> Export -> All.. (UnrealEd 4 - UT3)
* Export selected actors: File-> Export-> Selected Only ... (UnrealEd 4 only - UT3)
* Export one brush: Brush -> Export ...
* Copy/Paste: can copy paste any actor from any UnrealEd version to another one (Except for UnrealEd 4) or to any text editor such as notepad (Windows)

===Importing T3D ===

File -> Import...

(note importing may take a LONG time)

Overheard on #utjb... :-)

<tarquin> t3d stores brushes & actors but not texturing, right?
<Mychaeel> Texturing as well.
(melds into the opening speech from Reservoir Dogs...)
<DaveA>Stores links to textures, and texture transforms, but not the pixels themselves

The T3D format is a text file which stores information about map actors. It's in fact identical to what can be copied from UnrealEd to a text editor. An exported map looks like this:

<uscript>
Begin Map
Begin Actor Class=LevelInfo Name=LevelInfo0
TimeSeconds=17.008888
Summary=LevelSummary'Entry.LevelSummary'
DefaultGameType=Class'Botpack.UTIntro'
AIProfile(0)=23784352
AIProfile(1)=52
AIProfile(2)=41
AIProfile(3)=42
AIProfile(4)=40
AIProfile(5)=44
AIProfile(6)=45
AIProfile(7)=21846171
AvgAITime=0.000000
Level=LevelInfo'Entry.LevelInfo0'
Tag=LevelInfo
Region=(Zone=LevelInfo'Entry.LevelInfo0',iLeaf=-1)
Name=LevelInfo0
End Actor
Begin Actor Class=Brush Name=Brush0
MainScale=(SheerAxis=SHEER_ZX)
PostScale=(Scale=(X=0.250000,Y=8.000000,Z=3.000000),SheerAxis=SHEER_ZX)
TempScale=(Scale=(X=0.250000,Y=8.000000,Z=3.000000),SheerAxis=SHEER_ZX)
Level=LevelInfo'Entry.LevelInfo0'
Tag=Brush
Region=(Zone=ZoneInfo'Entry.ZoneInfo0',iLeaf=1,ZoneNumber=1)
Location=(X=464.000000,Y=-16.000000,Z=64.000000)
Begin Brush Name=Brush
Begin PolyList
Begin Polygon Item=OUTSIDE Texture=black1 Flags=4194304 Link=0
Origin -00160.000000,+00000.000000,+00128.000000
Normal +00000.000000,+00000.000000,+00001.000000
TextureU +00004.000000,+00000.000000,+00000.000000
TextureV +00000.000000,+00004.000000,+00000.000000
Vertex -00128.000000,-00128.000000,+00128.000000
Vertex +00128.000000,-00128.000000,+00128.000000
Vertex +00128.000000,+00128.000000,+00128.000000
Vertex -00128.000000,+00128.000000,+00128.000000
End Polygon
...
End PolyList
End Brush
Brush=Model'Entry.Brush'
Name=Brush0
End Actor
Begin Actor Class=PlayerStart Name=PlayerStart0
Level=LevelInfo'Entry.LevelInfo0'
Tag=PlayerStart
Region=(Zone=ZoneInfo'Entry.ZoneInfo0',iLeaf=1,ZoneNumber=1)
Location=(X=183.134430,Y=-987.334167,Z=33.978027)
OldLocation=(X=-217.561523,Y=-44.538128,Z=-87.899948)
Name=PlayerStart0
End Actor
...
End Map</uscript>

External link: http://web.archive.org/web/20060710080159/http://unreal.jall.org/tutorials/t3d.html (new URL)

=== T3D File Structure ===
== Ux,UT,UT200x Maps ==
<uscript>
Begin Map
Begin Actor Class=<ClassName>
...
End Actor
Begin Actor Class=<ClassName>
...
End Actor
...
End Map
</uscript>

== UT3 Maps ==
<uscript>
Begin Map
Begin Level NAME=PersistentLevel
Begin Actor Class=<ClassName>
...
End Actor
Begin Actor Class=<ClassName>
...
End Actor
...
End Level
Begin Surface
End Surface
End Map
</uscript>

Note: as UT3 T3D files have different header, any other not-UT3 t3d file can't be imported into UT3 editor (UnrealEd 4)

===T3D brush geometry===
Information geometry is contained in the following actors:
*Brush
*Mover (only UT and U1 game)

For more information about T3D brushes, see [http://wiki.beyondunreal.com/Legacy:T3D_Brush[T3D Brush]]

==T3D Utilities ==
* [[Legacy:MapScale|MapScale]] scales an entire .t3d file
* [[Legacy:MeshMaker|MeshMaker]] converts a prefab in .t3d format to a [[Legacy:Decoration|decoration]]
* [http://darendash.home.comcast.net/~darendash/Converter.html UnrealROC] converters: from 3DMF, to VRML/X3D/OBJ (including textures et al).

==Related Topics ==
* [[Legacy:Data Import And Export|Data Import and Export]]
* [[Legacy:Brush Exporting And Importing|Brush Exporting And Importing]]
* [[Legacy:Brush Hacking|Brush Hacking]]
* [[Legacy:T3D Brush|T3D Brush]]

'''Kefik:''' There can be also a tag 'CsgOper' which have one of two values ... 'CSG_Subtract' -> subtract the brush from space or 'CSG_Add' -> add this brush to shape.

'''Sobiwan:''' New to WIKI editing, but not using it. I was searching for the actual format of T3D and found 
[http://web.archive.org/web/20050913035722/http://users.skynet.be/fa550206/Slug-Production/Data/OpenGL-Documents/T3D-File-Format/T3D-File-Format.htm Mongo's description] of [http://www.planetunreal.com Planetunreal] to be extremely helpful. I'll ask him (mongo@planetunreal.com) if we can use and/or edit his description here. The format is much more involved than described here. We can even supply examples of how to do particular hacks.

'''MadNad:''' Interestingly, I was able to convert a [http://madnad.com/ut2k3/Screenshots/q3dm7.jpg?link Quake3_Level] into a unreal map. Quite interesting. First i converted a *.bsp to a *.map in quake, then I made a level that was just a huge cube and converted it to *.t3d. With an external app (i'll have to find the name of it ) I was able to merge these two together. After some scaling and switching additive brushes in quake to subtractive brushes in ued and subtractive to additive, I compiled and had q3dm7 geometry. I don't necessarily recommend doing this, as it will take more time to fix than create it from scratch, but I thought I would share a little experience I had with this.
--[[User:SeriousBarbie|SeriousBarbie]] ([[User talk:SeriousBarbie|talk]]) 21:11, 11 August 2016 (EDT)

Legacy:StatLog

2016-07-22T20:39:26Z

SeriousBarbie: +Known subclasses

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:Info (UT)|Info (UT)]] >> StatLog (Package: Botpack)}}

''StatLog'', native UnrealScript class. Provides means to write [http://www.unicode.org Unicode]-encoded text to (log-)files. Apart from writing to fixed .ini files, this class is UnrealScript's only means to write data to disk.

* StatLog's static BrowseRelativeLocalURL function is a handy way to create an in-game link to a locally saved HTML manual (of a mod, for instance). The ''start'' console command can only deal with actual network URLs.

== Known subclasses ==
*[[Legacy:StatLogFile (UT)|StatLogFile (UT)]]

[[Category:Legacy Class (UT)|{{PAGENAME}}]]