Difference between revisions of "User:Crusha/UltimateMappingTools/VIPlayerEventGate"

Revision as of 14:42, 8 June 2010

by Crusha K. Rool

Object >> Actor >> Triggers >> EventGate >> VIPlayerEventGate (custom)

This receives an incoming (Un)TriggerEvent and performs several checks about the Instigator of this Event. It will (un)trigger the next Event, depending on what the result of the check is.

Variables

Property group 'Events'

Event

Type: name

This Event is (un)triggered if the Instigator matches a set of criteria from the Whitelist.

BlacklistEvent

Type: name

This Event is (un)triggered if the Instigator matches a set of criteria from the Blacklist and not from the Whitelist.

NoMatchEvent

Type: name

This Event is (un)triggered if the Instigator does neither match a set of criteria from the Whitelist nor from the Blacklist.

Property group 'VIPlayerEventGate'

bKillWarezPlayers

Type: bool

Kill the Instigator immediately, if he's using a demo CD-key. Otherwise nothing happens, none of the above Events will be triggered for demo key players.

Whitelist

Type: array<_PlayerProperties>

The Instigators with these criteria trigger the default Event.

Blacklist

Type: array<_PlayerProperties>

The Instigators with these criteria trigger the BlacklistEvent.

Struct 'SpawnedVehicleProperties'

PlayerName

Type: String

This string must be contained in (i.e. can also be just a part of) the Instigator's name. Leaving this blank disables the criteria.

bCheckExactName

Type: bool

Instigator's name must be EXACTLY the one entered in the PlayerName-field. (Unless the field is blank)

MustBeAdmin

Type: ECheckResult

Instigator needs to be logged in as Admin

MustBeBot

Type: ECheckResult

Instigator needs to be a bot

bVehicleCheck

Type: bool

True to check whether the Instigator is in the RequiredVehicle, False to ignore this criterion.

RequiredVehicle

Type: class<Vehicle>

The Instigator must be in this vehicle. None = must go by foot ; Vehicle = can be any vehicle (but still must be in a vehicle).

PlayerID

Type: String

Instigator needs to have this exact sequence of characters somewhere in his ID.

The ID is a unique string that is a hash representation of your CD-key. It can be seen in the ingame settings. It's pretty impossible to calculate someone's CD-key from the hash, but for paranoid people (like me), I created this criterion in a way that it's enough to enter only a part of the ID. The function will only check if the Instigator's ID contains this specified sequence somewhere in it. The longer the sequence, the less the chance of a false-positive, but a player should be unique identifiable also without entering the full sequence here. Only give as much away as you can afford. Of course it's pretty useless if you use different parts of your ID in different maps of yours, right? Stick with one, if you use this at all. ;)

MinimumRequiredScore

Type: int

Instigator needs to have at least this much points. Enter a very low value to let everyone pass this check without problems, i.e. disable it by entering -100 or something like that. Unless you want to restrict suicidal noobs. ;)

TeamIndex

Type: int

Instigator needs to be in this specific team. 0= red, 1= blue, 255= disable check

The team number will be switched on Reset if required in ONS.

Enums

ECheckResult

ECR_Any: Ignore this criteria

ECR_True: Result must be true to be considered a match

ECR_False: Result must be false to be considered a match.

Author comments

This actor is supposed to allow authorized personnel like Admins, clan members or the mapper himself to cause certain Events in the map, what can become pretty handy in conjunction with other actors of my tool set.

However, this actor is basically also a way to let the mapper do certain things to certain players which might not be fair, for example healing one kind of players and keeping the other kind of players from using a certain door, etc.

There are many ways how such a thing can be abused, but I follow the rule that I just offer you the tools and it's about you what you do with them. Keep in mind that players won't play your map if they feel like you give certain players advantages over the others and there is nothing they can do about it. No Admin will put such a map up in which you abuse this tool, unless he can bear to become a pretty empty server quickly.

I also added the restriction to distinguish players with the demo CD-key. Ok, killing them might be too hard, that's why I integrated it optionally, but I somehow found that it would be fair that those who paid for the game has the right to play it in it's full spectrum while the other guys have exceeded their testing time and shouldn't get all the features. Seriously, just buy the game if you haven't done yet.