Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.AccessControl

Extends
Info
Modifiers
config ( Game )

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.AccessControl

Constants Summary
Inherited Contants from Engine.Actor
ACTORMAXSTEPHEIGHT, MINFLOORZ, RBSTATE_ANGVELSCALE, RBSTATE_LINVELSCALE, RB_NeedsUpdate, RB_None, RB_Sleeping, REP_RBLOCATION_ERROR_TOLERANCE_SQ, TRACEFLAG_Blocking, TRACEFLAG_Bullet, TRACEFLAG_PhysicsVolumes, TRACEFLAG_SkipMovers

Variables Summary
stringACDescText[3]
stringACDisplayText[3]
class<Admin>AdminClass
stringAdminPassword
stringBannedCDHashKeyString
array<BannedHashInfo>BannedHashes
array<UniqueNetID>BannedIDs
array<BannedInfo>BannedPlayerInfo
boolbDontAddDefaultAdmin
stringDefaultKickReason
stringGamePassword
stringIdleKickReason
stringIPBanned
array<string>IPPolicies
stringKickedMsg
stringNeedPassword
stringSessionBanned
array<SessionBanInfo>SessionBans
stringTimedOutCDHashKeyString
stringWrongPassword
Inherited Variables from Engine.Actor
Acceleration, AllComponents, Attached, bAlwaysEncroachCheck, bAlwaysRelevant, bAlwaysTick, Base, BaseBoneName, BaseSkelComponent, bBlockActors, bBlocksNavigation, bBlocksTeleport, bBounce, bCanBeAdheredTo, bCanBeDamaged, bCanBeFrictionedTo, bCanTeleport, bClientDemoRecording, bCollideActors, bCollideComplex, bCollideWhenPlacing, bCollideWorld, bComponentOutsideWorld, bConsiderAllStaticMeshComponentsForStreaming, bDebug, bDeleteMe, bDemoOwner, bDemoRecording, bDestroyedByInterpActor, bDestroyInPainVolume, bEdShouldSnap, bExchangedRoles, bForceNetUpdate, bGameRelevant, bHardAttach, bHasAlternateTargetLocation, bHidden, bHiddenEd, bHiddenEdCustom, bHiddenEdGroup, bHurtEntry, bIgnoreBaseRotation, bIgnoreEncroachers, bIgnoreRigidBodyPawns, bIsMoving, bJustTeleported, bKillDuringLevelTransition, bLockLocation, BlockRigidBody, bMovable, bNetDirty, bNetInitial, bNetInitialRotation, bNetOwner, bNetTemporary, bNeverReplicateRotation, bNoDelete, bNoEncroachCheck, bOnlyDirtyReplication, bOnlyOwnerSee, bOnlyRelevantToOwner, bOrientOnSlope, bPathColliding, bPathTemp, bPendingDelete, bPendingNetUpdate, bPhysRigidBodyOutOfWorldCheck, bPostRenderIfNotVisible, bProjTarget, bPushedByEncroachers, bRepClientDemo, bReplicateInstigator, bReplicateMovement, bReplicateRigidBodyLocation, bRouteBeginPlayEvenIfStatic, bScriptInitialized, bShadowParented, bShouldBaseAtStartup, bSkipActorPropertyReplication, bStasis, bStatic, bTearOff, bTempEditor, bTicked, bUpdateSimulatedPosition, bWorldGeometry, Children, CollisionComponent, CollisionType, Components, CreationTime, CustomTimeDilation, DesiredRotation, DetachFence, DrawScale, DrawScale3D, GeneratedEvents, Group, InitialState, Instigator, LastNetUpdateTime, LastRenderTime, LatentActions, LatentFloat, LatentSeqNode, LifeSpan, Location, MessageClass, MinDistForNetRBCorrection, NetPriority, NetTag, NetUpdateFrequency, NetUpdateTime, OverlapTag, Owner, PendingTouch, Physics, PhysicsVolume, PrePivot, RelativeLocation, RelativeRotation, RemoteRole, Role, Rotation, RotationRate, SupportedEvents, Tag, TickGroup, Timers, Touching, Velocity, WorldInfo

Enumerations Summary
Inherited Enumerations from Engine.Actor
ECollisionType, EDoubleClickDir, EMoveDir, ENetRole, EPhysics, ETravelType

Structures Summary
BannedHashInfo
PlayerName, BannedHash
BannedInfo
BannedID, PlayerName, TimeStamp
SessionBanInfo
BanID, BanHash, BanIP
Inherited Structures from Engine.Info
KeyValuePair, PlayerResponseLine, ServerResponseLine
Inherited Structures from Engine.Actor
AnimSlotDesc, AnimSlotInfo, AsyncLineCheckResult, CollisionImpactData, ImpactInfo, NavReference, ReplicatedHitImpulse, RigidBodyContactInfo, RigidBodyState, TimerData, TraceHitInfo

Functions Summary
function AdminEntered (PlayerController P ))
function AdminExited (PlayerController P ))
functionbool AdminLogin (PlayerController P, string Password ))
functionbool AdminLogout (PlayerController P))
functionbool CheckIPPolicy (string Address))
functionController GetControllerFromString (string Target))
functionbool IsAdmin (PlayerController P))
functionbool IsHashBanned (const string HashToCheck))
functionbool IsIDBanned (const out UniqueNetID NetID))
function Kick (string Target ))
function KickBan (string Target ))
functionbool KickPlayer (PlayerController C, string KickReason))
functionbool ParseAdminOptions (string Options ))
event PreLogin (string Options, string Address, out string OutError, bool bSpectator))
functionbool RequiresPassword ()))
function SessionBan (string Target))
function SessionBanPlayer (PlayerController C))
functionbool SetAdminPassword (string P))
function SetGamePassword (string P))
functionbool ValidLogin (string UserName, string Password))
Inherited Functions from Engine.Actor
ActivateEventClass, AllActors, AllOwnedComponents, Attach, AttachComponent, AutonomousPhysics, BaseChange, BasedActors, BecomeViewTarget, BeginAnimControl, BroadcastLocalizedMessage, BroadcastLocalizedTeamMessage, Bump, CalcCamera, CanSplash, ChartData, CheckForErrors, CheckHitInfo, CheckMaxEffectDistance, ChildActors, ClampRotation, ClearLatentAction, ClearTimer, Clock, CollidingActors, CollisionChanged, ComponentList, ConsoleCommand, ConstraintBrokenNotify, ContainsPoint, CreateAudioComponent, DebugFreezeGame, Destroy, Destroyed, Detach, DetachComponent, DisplayDebug, DoKismetAttachment, DrawDebugBox, DrawDebugCone, DrawDebugCoordinateSystem, DrawDebugCylinder, DrawDebugLine, DrawDebugSphere, DynamicActors, EffectIsRelevant, EncroachedBy, EncroachingOn, EndViewTarget, Falling, FastTrace, FellOutOfWorld, FindActorsOfClass, FindBase, FindEventsOfClass, FindGoodEndView, FindSpot, FinishAnim, FinishAnimControl, FlushPersistentDebugLines, ForceNetRelevant, ForceUpdateComponents, GainedChild, GetActorEyesViewPoint, GetActorFaceFXAsset, GetBaseMost, GetBoundingCylinder, GetComponentsBoundingBox, GetDebugName, GetDestination, GetFaceFXAudioComponent, GetGravityZ, GetHumanReadableName, GetItemName, GetLocalString, GetLocationStringFor, GetPackageGuid, GetPhysicsName, GetTargetLocation, GetTeamNum, GetTerminalVelocity, GetTimerCount, GetTimerRate, GetURLMap, GetUTFlag, HealDamage, HitWall, HurtRadius, InterpolationChanged, InterpolationFinished, InterpolationStarted, IsActorPlayingFaceFXAnim, IsBasedOn, IsInPain, IsInVolume, IsOverlapping, IsOwnedBy, IsPlayerOwned, IsStationary, IsTimerActive, KilledBy, Landed, LocalPlayerControllers, LostChild, MakeNoise, MatchStarting, ModifyHearSoundComponent, Move, MoveSmooth, MovingWhichWay, NativePostRenderFor, NotifyLocalPlayerTeamReceived, NotifySkelControlBeyondLimit, OnAnimEnd, OnAnimPlay, OnAttachToActor, OnCauseDamage, OnChangeCollision, OnDestroy, OnHealDamage, OnMakeNoise, OnRanOver, OnSetBlockRigidBody, OnSetPhysics, OnTeleport, OnToggleHidden, OutsideWorldBounds, OverlappingActors, OverRotated, PawnBaseDied, PhysicsVolumeChange, PickedUpBy, PlayActorFaceFXAnim, PlayerCanSeeMe, PlaySound, PlayTeleportEffect, PointCheckComponent, PostBeginPlay, PostInitAnimTree, PostRenderFor, PostTeleport, PostTouch, PreBeginPlay, PreTeleport, RanInto, ReplaceText, ReplicatedEvent, Reset, RigidBodyCollision, RootMotionExtracted, RootMotionModeChanged, ScriptGetTeamNum, SetAnimPosition, SetAnimWeights, SetBase, SetCollision, SetCollisionSize, SetDrawScale, SetDrawScale3D, SetForcedInitialReplicatedProperty, SetGRI, SetHardAttach, SetHidden, SetHUDLocation, SetInitialState, SetLocation, SetMorphWeight, SetNetUpdateTime, SetOnlyOwnerSee, SetOwner, SetPhysics, SetRelativeLocation, SetRelativeRotation, SetRotation, SetSkelControlScale, SetTickGroup, SetTimer, SetZone, ShutDown, Sleep, Spawn, SpawnedByKismet, SpecialHandling, StopActorFaceFXAnim, StopsProjectile, SuggestTossVelocity, TakeDamage, TakeRadiusDamage, Tick, Timer, TimeSince, TornOff, Touch, TouchingActors, Trace, TraceActors, TraceComponent, TriggerEventClass, UnClock, UnTouch, UsedBy, VisibleActors, VisibleCollidingActors


Variables Detail

ACDescText[3] Source code

var localized string ACDescText[3];

ACDisplayText[3] Source code

var localized string ACDisplayText[3];

AdminClass Source code

var class<Admin> AdminClass;

AdminPassword Source code

var private globalconfig string AdminPassword;

BannedCDHashKeyString Source code

var localized string BannedCDHashKeyString;
String to display when kicked for banned CD hash key

BannedHashes Source code

var globalconfig array<BannedHashInfo> BannedHashes;

BannedIDs Source code

var globalconfig array<UniqueNetID> BannedIDs;

BannedPlayerInfo Source code

var globalconfig array<BannedInfo> BannedPlayerInfo;

bDontAddDefaultAdmin Source code

var bool bDontAddDefaultAdmin;

DefaultKickReason Source code

var localized string DefaultKickReason;

GamePassword Source code

var private globalconfig string GamePassword;

IdleKickReason Source code

var localized string IdleKickReason;

IPBanned Source code

var localized string IPBanned;

IPPolicies Source code

var globalconfig array<string> IPPolicies;

KickedMsg Source code

var localized string KickedMsg;

NeedPassword Source code

var localized string NeedPassword;

SessionBanned Source code

var localized string SessionBanned;

SessionBans Source code

var array<SessionBanInfo> SessionBans;

TimedOutCDHashKeyString Source code

var localized string TimedOutCDHashKeyString;
String to display when kicked for a timed out CD hash key request

WrongPassword Source code

var localized string WrongPassword;


Structures Detail

BannedHashInfo Source code

struct BannedHashInfo
{
var string BannedHash;
var string PlayerName;
};


BannedInfo Source code

struct BannedInfo
{
var UniqueNetID BannedID;
var string PlayerName;
var string TimeStamp;
};


SessionBanInfo Source code

struct SessionBanInfo
{
var string BanHash;
var UniqueNetID BanID;
var string BanIP;
};



Functions Detail

AdminEntered Source code

function AdminEntered ( PlayerController P ) )

AdminExited Source code

function AdminExited ( PlayerController P ) )

AdminLogin Source code

function bool AdminLogin ( PlayerController P, string Password ) )

AdminLogout Source code

function bool AdminLogout ( PlayerController P) )

CheckIPPolicy Source code

function bool CheckIPPolicy ( string Address) )

GetControllerFromString Source code

function Controller GetControllerFromString ( string Target) )
Takes a string and tries to find the matching controller associated with it. First it searches as if the string is the player's name. If it doesn't find a match, it attempts to resolve itself using the target as the player id.
@Params Target The search key
@returns the controller assoicated with the key. NONE is a valid return and means not found.

IsAdmin Source code

function bool IsAdmin ( PlayerController P) )

@return TRUE if the specified player has admin priveleges.

IsHashBanned Source code

function bool IsHashBanned ( const string HashToCheck) )

IsIDBanned Source code

function bool IsIDBanned ( const out UniqueNetID NetID) )

Kick Source code

function Kick ( string Target ) )

KickBan Source code

function KickBan ( string Target ) )

KickPlayer Source code

function bool KickPlayer ( PlayerController C, string KickReason) )

ParseAdminOptions Source code

function bool ParseAdminOptions ( string Options ) )
Parses the specified string for admin auto-login options
@param Options a string containing key/pair options from the URL (?key=value,?key=value)
@return TRUE if the options contained name and password which were valid for admin login.

PreLogin Source code

event PreLogin ( string Options, string Address, out string OutError, bool bSpectator) )

RequiresPassword Source code

function bool RequiresPassword ( ) )

SessionBan Source code

function SessionBan ( string Target) )

SessionBanPlayer Source code

function SessionBanPlayer ( PlayerController C) )
Since ClientWasKicked() is a client side function that if modified they won't have anyway

SetAdminPassword Source code

function bool SetAdminPassword ( string P) )

SetGamePassword Source code

function SetGamePassword ( string P) )

ValidLogin Source code

function bool ValidLogin ( string UserName, string Password) )

@return TRUE if the specified username + password match the admin username/password


Defaultproperties

defaultproperties
{
   IPPolicies(0)="ACCEPT;*"
   IPBanned="Your IP address has been banned on this server."
   WrongPassword="The password you entered is incorrect."
   NeedPassword="You need to enter a password to join this game."
   SessionBanned="Your IP address has been banned from the current game session."
   KickedMsg="You have been forcibly removed from the game."
   DefaultKickReason="None specified"
   IdleKickReason="Kicked for idling."
   BannedCDHashKeyString="Banned CD Key."
   TimedOutCDHashKeyString="Key check failed with the server.  Please update with the latest patch."
   AdminClass=Class'Engine.Admin'
   ACDisplayText(0)="Game Password"
   ACDisplayText(1)="Access Policies"
   ACDisplayText(2)="Admin Password"
   ACDescText(0)="If this password is set, players will have to enter it to join this server."
   ACDescText(1)="Specifies IP addresses or address ranges which have been banned."
   ACDescText(2)="Password required to login with administrator privileges on this server."
   Begin Object Class=SpriteComponent Name=Sprite ObjName=Sprite Archetype=SpriteComponent'Engine.Default__Info:Sprite'
      ObjectArchetype=SpriteComponent'Engine.Default__Info:Sprite'
   End Object
   Components(0)=Sprite
   CollisionType=COLLIDE_CustomDefault
   Name="Default__AccessControl"
   ObjectArchetype=Info'Engine.Default__Info'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:34.403 - Created with UnCodeX