Properties

From Control_Point
Revision as of 12:11, 14 June 2020 by Ecnassianer (talk | contribs) (Components)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Don't see a property documented on this page? Mouse over it in the editor, all the properties have tooltips, I might just have forgotten to copy it here, so send me a message on Discord and I'll update it.

Control Point Teams

ControlPointTeams.JPG

Teams: This is an array of all the teams that can use this control point. You can add as many teams as you'd like.

NeutralTeamColor: This is what color should be used to identify capture points that aren't controlled by a team.

Each team has its own set of properties to help define that team. The properties for each team are:

TeamColor: This is what color should be used to identify the team. It will be passed into materials, UI, etc.

GameplayTagsBelongingToTheTeam: Any actors with the tags in this list will automatically count as members of the team.

ActorInstancesBelongingToTeam: Any actors in this list will count as members of the team.

ClassesBelongingToTeam: Any instances of these classes will automatically count as members of the team.

CanCapture: Whether this team can capture this point or not.

Control Point

ControlPointProperties.JPG

IsTurnedOn: Whether the point is currently enabled and visible in the world.

StartLocked: Whether the control point should start locked or unlocked. Being locked prevents any team from changing the capture state of the point.

InitialControllingTeam: What team controls this point when the game starts.

BaseCapturePercentagePerSecond: The rate at which the point captures when one person is standing on it.

ExtraPlayerCaptureMultiplier: Each additional player beyond the first makes the capture happen this much faster. 0 is no bonus. 1 means the second player will make it capture twice as fast, third player 3 times as fast, etc.

CaptureInstantly: Whether to capture the control point the instant its touched and not blocked.

FullCaptureResponse: How the control point behaves when the capture percentage reaches 100%.

FullyRestoreWhenTouchedByControllingTeam: Allows the controlling team to instantly reset their points to 100% capture if the other team has stopped stealing control from them.

RestorePercentagePerSecond: How quickly captured points regenerate to 100% when no actors are capturing them.

ControlDrainPerSecond: The rate at which control drains when no one is on the point. (See FullCaptureResponse.)

DelayBeforeDrainStarts: How long an unoccupied control point waits before it starts draining, in seconds.

ControlDrainsInstantlyOnceStarted: If true, control will reset to zero the moment no one is on the point.

ScorePerSecondHeld: This amount of score is given out for every second held until Available Score is depleted.

AvailableScore: The maximum amount of score that can be extracted from this point.

Don'tScoreWhileContested: If a point is contested, it won't reward points to the controlling team until it is no longer contested.

Control Point Internals

There is a category of properties called "Control Point Internals". These are private variables used by the Control Point code that shouldn't be changed. You can ignore everything in this category.

Single Player Cheats

SinglePlayerCheats.JPG

These buttons allow you to cheat different effects for debugging. They only work in single player, not with dedicated server turned on.

Add 10Percent: Adds 10 percent to the current capture amount.

Capture For Team 0: Switch control of the point to Team 0.

Capture for Team 1: Switch control of the point to Team 1.

Remove 10Percent: Reduce the current capture amount by 10 percent.

Toggle Locked: Toggle whether the control point is locked or unlocked.

Uncapture: Switch control of the point to no one.

Show Debug Display: Turns on a text display that shows what team controls the point and what the capture percentage is.

Capture Results

CapturePointCaptureResults.JPG

Team Color Material Parameters: Material instances in this array will have a Vector Parameter named "Color" set to the controlling team's color, and a Scalar Parameter named "Locked" set to 0 or 1 based on whether the control point is locked or not. This can be used to control materials inside the control point actor, or in the environment surrounding the capture point.

Points to Lock On Capture: Control points in this array will be locked when this control point is captured.

Points to Unlock On Capture: Control points in this array will be unlocked when this control point is captured.

Points to Uncapture On Capture: Control points in this array will be uncaptured when this control point is captured.

Components

CapturePointGeo.JPG

CaptureGeometry: Any geometry under this scene object will be used as the capture volume for this control point.

DebugText: Text under this scene object is used for the debug display that can be enabled in Single Player Cheats (though it works fine in multiplayer, too).