Control_Point - User contributions [en]

Blueprint Functions

2021-09-03T23:17:11Z

Ecnassianer: /* Control Point Internals */

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals==

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overridden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

'''Increase Capture For Controlling Team''': This function calculates the rate that a control point is captured. It is ''extra'' internal, so overriding it is not recommended. However, I thought a lot about a character class specific capture rate (like the Scout in TF2), or a magic buff that makes you capture faster, but it's really hard to support something like that without knowing the full context about the game. The best way I figure someone could do this is to override Increase Capture For Controlling Team with whatever logic they want in there for classes, or buffs, or whatever. This is technically "against the rules" because it's a Control Point Internal function, so I reserve the right to change its signature or how it functions in the future, which might break your overridden version. But I purposefully extracted this logic out into its own function knowing someone would want to do it eventually.
It should be fairly safe to assume:
* This function always gets Delta Time
* Always sets Capture Percentage
* Always calls Evaluate Team Control before it returns.
I'm unlikely to change those assumptions in a future version, so if you follow them, it probably won't break.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the buttons in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Blueprint Functions

2021-09-03T23:16:42Z

Ecnassianer: /* Control Point Internals */

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals==

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overridden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

'''Increase Capture For Controlling Team''': This function calculates the rate that a control point is captured. It is ''extra'' internal, so overriding it is not recommended. However, I thought a lot about a character class specific capture rate (like the Scout in TF2), or a magic buff that makes you capture faster, but it's really hard to support something like that without knowing the full context about the game. The best way I figure someone could do this is to override Increase Capture For Controlling Team with whatever logic the want in there for classes, or buffs, or whatever. This is technically "against the rules" because it's a Control Point Internal function, so I reserve the right to change its signature or how it functions in the future, which might break your overridden version. But I purposefully extracted this logic out into its own function knowing someone would want to do it eventually.
It should be fairly safe to assume:
* This function always gets Delta Time
* Always sets Capture Percentage
* Always calls Evaluate Team Control before it returns.
I'm unlikely to change those assumptions in a future version, so if you follow them, it probably won't break.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the buttons in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Blueprint Functions

2021-09-03T23:16:04Z

Ecnassianer: /* Control Point Internals */

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals==

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overridden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

'''Increase Capture For Controlling Team''': This function calculates the rate that a control point is captured. It is ''extra'' internal, so overriding it is not recommended. However, I thought a lot about a character class specific capture rate (like the Scout in TF2), or a magic buff that makes you capture faster, but it's really hard to do something like that without knowing my context about the full game. The best way I figure someone could do this is to override Increase Capture For Controlling Team with whatever logic the want in there for classes, or buffs, or whatever. This is technically "against the rules" because it's a Control Point Internal function, so I reserve the right to change its signature or how it functions in the future, which might break your overridden version. But I purposefully extracted this logic out into its own function knowing someone would want to do it eventually.
It should be fairly safe to assume:
* This function always gets Delta Time
* Always sets Capture Percentage
* Always calls Evaluate Team Control before it returns.
I'm unlikely to change those assumptions in a future version, so if you follow them, it probably won't break.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the buttons in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Main Page

2020-08-04T16:42:44Z

Ecnassianer:

Control Point is an Unreal asset for use in multiplayer game modes like
* Overwatch's Payload
* Destiny's Control
* Halo's King of the Hill
* CTF
* Unreal Tournament's Assault

Control points are [[Control Point Setup|super easy to implement]] and highly customizable. There's documentation on[[Properties| all the properties]] that can be used to tune the control point.

The asset also comes with a default team implementation, but [[Overriding Team Management|it's also easy to use your own]]. In fact, many complex rulesets and custom behaviors are capable through the [[Blueprint Functions|Blueprint API]].

Real time support for Multiplayer Control Point Asset is available on [https://discord.gg/nYSpyZF Discord]. There is also a [http://cp.greenstorm.net/downloads/MCP-StandaloneDemo.zip standalone demo].

Main Page

2020-06-14T19:46:09Z

Ecnassianer:

Blueprint Functions

2020-06-14T19:44:42Z

Ecnassianer: /* Single Player Capture Point Dev Cheats */

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals==

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overriden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the buttons in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Main Page

2020-06-14T19:44:12Z

Ecnassianer:

Main Page

2020-06-14T19:43:37Z

Ecnassianer:

Main Page

2020-06-14T19:43:23Z

Ecnassianer:

Main Page

2020-06-14T19:43:09Z

Ecnassianer:

Main Page

2020-06-14T19:42:51Z

Ecnassianer:

Main Page

2020-06-14T19:42:33Z

Ecnassianer:

Blueprint Functions

2020-06-14T19:41:33Z

Ecnassianer: /* Control Point Internals= */

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals==

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overriden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the bottoms in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Blueprint Functions

2020-06-14T19:40:49Z

Ecnassianer: Created page with "This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code. Functions in the "Control Point Internals" c..."

This page documents all the public blueprint functions that you can safely use to manipulate a control point from your game code.

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. Do not modify, or call them yourself. Some can be safely overriden to change the behavior of your child actors, but their call signature may change without warning in future versions.

==Control Point==
'''AddCapturingActor''': Make an actor count as capturing this control point. Could be used to allow actors to capture from range (without colliding with the point)

'''RemoveCapturingActor''': Remove an actor from the list of actors that are capturing a point. Might be useful to temporarily make an actor not count toward a capture.

'''ForceCaptureForTeam''': Force the control state of a point to a specific team regardless of who is capturing it.

'''ControllingTeamOnPointCount''': The number of actors that belong to the controlling team that are currently on the point.

'''GetCapturePercentage''': The percentage from 0 to 100 that a control point is captured.

'''GetControllingTeamsColor''': Gives the team color of the team currently in control of the point. If no team is in control, it returns 0,0,0,0.

'''PrintStatus''': Handles updating debug text for capture status. This is called automatically in many places, but it is also available to you for debugging.

'''GetExtraPlayersBonus''': Figures out how much faster the point captures for each additional capturing actor currently on the point. Override this for custom bonus behavior.

==Control Point Internals===

Functions in the "Control Point Internals" category are private functions that should only be used internally by the control point. '''Do not modify, or call them yourself'''. Some can be safely overriden to change the behavior of your child actors, but '''their call signature may change without warning in future versions'''. To add new behavior, it is better to respond to [[Control Point Events]], only override these functions if you wish to replace existing behavior.

'''Drain Control Percentage''': Called each frame a control point is having it's capture percentage drained. Override this to do something weird with draining. Sets the Capture Percentage variable.

'''Calculate Score''': Calculates how much score is awarded per second for the controlling team. Override this to do something weird with points. Score is not the same as capture percentage.

==Control Point Teams==
'''GetNumberOfTeams''': Returns the number of teams this control point is set up to be captured by.

'''GetTeamColor''': Gets the team color of a particular team.

'''Override Team''': An easy way to set the team arrays at runtime. See [[Overriding Team Management]]

'''AddActorToTeam''': Adds an actor instance to one of the teams.

'''Get Actor's Team''': Gets the team that an actor is on.

'''CanActorCapture''': Returns true if the specified actor is cable to capture or block capture of this point.

==Single Player Capture Point Dev Cheats==
These functions do the same thing as the bottoms in the property panel, but they can also be called programmatically.

'''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.

==Control Point Capture Results==

'''UpdateMaterialParametersDuringConstructionScript''': If you override the construction script to register team colored dynamic material instances, call this after you're done to update them.

'''RegisterTeamColoredDynamicMaterialInstance''': A way to register which materials should have their Color parameter updated with the controlling team's color. CaptureGeometry is automatically registered, so you don't need to call this on them.

Main Page

2020-06-14T19:25:55Z

Ecnassianer:

Main Page

2020-06-14T19:23:49Z

Ecnassianer:

Control Point Setup

2020-06-14T19:23:34Z

Ecnassianer: Ecnassianer moved page Super easy to implement to Control Point Setup

==Examples==
Inside the Examples folder there is a map called ControlPointExampleMap that contains many different example setups. You're welcome to use these in your own game, or just reference them as you make your own.

The simplest control point is BP_BasicControlPoint, and it is ready to be dropped in your game. Simply add GameplayTags, ActorInstances, or Classes to both teams for each point and you're ready to go.

The UI folder also contains many examples of how to create UI that responds to control point states, but these UIs are pretty ugly, and meant only as an example for integrating control points into your own UI.

==Quick Setup==

To create a control point from scratch, you should
# Create a Child blueprint of BP_ControlPointBase
# Add geometry to the CaptureGeometry scene.
# Create the appropriate number of teams and assign team colors.
# Choose which method you want to use for assigning teams members (you can also mix and match):
#* Actor instances is the simplest, simply add your actors to this array and they are on the team.
#* A GameplayTag can be used for each team, and then simply assigned to all actors of that team.
#* You can also assign a class type for each team. This is helpful if you already have different pawn types for each team.
#* You can also [[Overriding Team Management|override the team adding function]] and assign teams programatically.
# If you want your capture volume geometry to be team colored, assign their material instances to the Team Color Material Parameters
# Place instances of your control points in a map.

Super easy to implement

2020-06-14T19:23:34Z

Ecnassianer: Ecnassianer moved page Super easy to implement to Control Point Setup

#REDIRECT [[Control Point Setup]]

Control Point Setup

2020-06-14T19:22:52Z

Ecnassianer: /* Quick Setup */

Control Point Setup

2020-06-14T19:22:32Z

Ecnassianer:

==Examples==
Inside the Examples folder there is a map called ControlPointExampleMap that contains many different example setups. You're welcome to use these in your own game, or just reference them as you make your own.

The simplest control point is BP_BasicControlPoint, and it is ready to be dropped in your game. Simply add GameplayTags, ActorInstances, or Classes to both teams for each point and you're ready to go.

The UI folder also contains many examples of how to create UI that responds to control point states, but these UIs are pretty ugly, and meant only as an example for integrating control points into your own UI.

==Quick Setup==

To create a control point from scratch, you should
# Create a Child blueprint of BP_ControlPointBase
# Add geometry to the CaptureGeometry scene.
# Create the appropriate number of teams and assign team colors.
# Choose which method you want to use for assigning teams members (you can also mix and match):
#* Actor instances is the simplest, simply add your actors to this array and they are on the team.
#* A GameplayTag can be used for each team, and then simply assigned to all actors of that team.
#* You can also assign a class type for each team. This is helpful if you already have different pawn types for each team.
#* You can also [[Overriding Team Management|override the team adding function]] and assign teams programatically.
# If you want your capture volumes to be team colored, assign their material instances to the Team Color Material Parameters
# Place instances of your control points in a map.

Control Point Setup

2020-06-14T19:22:16Z

Ecnassianer:

==Examples==
Inside the Examples folder there is a map called ControlPointExampleMap that contains many different example setups. You're welcome to use these in your own game, or just reference them as you make your own.

The simplest control point is BP_BasicControlPoint, and it is ready to be dropped in your game. Simply add GameplayTags, ActorInstances, or Classes to both teams for each point and you're ready to go.

The UI folder also contains many examples of how to create UI that responds to control point states, but these UIs are pretty ugly, and meant only as an example for integrating control points into your own UI.

==Quick Setup==

To create a control point from scratch, you should
# Create a Child blueprint of BP_ControlPointBase
# Add geometry to the CaptureGeometry scene.
# Create the appropriate number of teams and assign team colors.
# Choose which method you want to use for assigning teams members.
#* Actor instances is the simplest, simply add your actors to this array and they are on the team.
#* A GameplayTag can be used for each team, and then simply assigned to all actors of that team.
#* You can also assign a class type for each team. This is helpful if you already have different pawn types for each team.
#* You can also [[Overriding Team Management|override the team adding function]] and assign teams programatically.
# If you want your capture volumes to be team colored, assign their material instances to the Team Color Material Parameters
# Place instances of your control points in a map.

Control Point Setup

2020-06-14T19:21:56Z

Ecnassianer: Created page with "==Examples== Inside the Examples folder there is a map called ControlPointExampleMap that contains many different example setups. You're welcome to use these in your own game,..."

==Examples==
Inside the Examples folder there is a map called ControlPointExampleMap that contains many different example setups. You're welcome to use these in your own game, or just reference them as you make your own.

The simplest control point is BP_BasicControlPoint, and it is ready to be dropped in your game. Simply add GameplayTags, ActorInstances, or Classes to both teams for each point and you're ready to go.

The UI folder also contains many examples of how to create UI that responds to control point states, but these UIs are pretty ugly, and meant only as an example for integrating control points into your own UI.

==Quick Setup==

To create a control point from scratch, you should
# Create a Child blueprint of BP_ControlPointBase
# Add geometry to the CaptureGeometry scene.
# Create the appropriate number of teams and assign team colors.
# Choose which method you want to use for assigning teams members.
## Actor instances is the simplest, simply add your actors to this array and they are on the team.
## A GameplayTag can be used for each team, and then simply assigned to all actors of that team.
## You can also assign a class type for each team. This is helpful if you already have different pawn types for each team.
## You can also [[Overriding Team Management|override the team adding function]] and assign teams programatically.
# If you want your capture volumes to be team colored, assign their material instances to the Team Color Material Parameters
# Place instances of your control points in a map.

Main Page

2020-06-14T19:13:20Z

Ecnassianer:

Properties

2020-06-14T19:11:14Z

Ecnassianer: /* Components */

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==

[[File:ControlPointTeams.JPG|700px]]

'''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==
[[File:ControlPointProperties.JPG|700px]]

'''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==
[[File:SinglePlayerCheats.JPG|700px]]

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==
[[File:CapturePointCaptureResults.JPG|700px]]

'''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==
[[File: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).

Properties

2020-06-14T19:08:23Z

Ecnassianer: /* Capture Results */

Properties

2020-06-14T19:05:16Z

Ecnassianer: /* Capture Results */

Properties

2020-06-14T19:01:37Z

Ecnassianer: /* Single Player Cheats */

Properties

2020-06-14T18:55:13Z

Ecnassianer:

Properties

2020-06-14T18:54:56Z

Ecnassianer: /* Control Point Teams */

Properties

2020-06-14T18:49:29Z

Ecnassianer:

Properties

2020-06-14T17:57:23Z

Ecnassianer:

==Control Point Teams==

[[File:ControlPointTeams.JPG|700px]]

==Control Point==
[[File:ControlPointProperties.JPG|700px]]

'''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==

==Single Player Cheats==
[[File:SinglePlayerCheats.JPG|700px]]

==Capture Results==
[[File:CapturePointCaptureResults.JPG|700px]]

==Components==
[[File:CapturePointGeo.JPG]]

Properties

2020-06-14T17:55:51Z

Ecnassianer:

==Control Point Teams==

[[File:ControlPointTeams.JPG|700px]]

==Control Point==
[[File:ControlPointProperties.JPG|700px]]

'''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.

==Control Point Internals==

==Single Player Cheats==
[[File:SinglePlayerCheats.JPG|700px]]

==Capture Results==
[[File:CapturePointCaptureResults.JPG|700px]]

==Components==
[[File:CapturePointGeo.JPG]]

Properties

2020-06-14T17:50:07Z

Ecnassianer:

==Control Point Teams==

[[File:ControlPointTeams.JPG|700px]]

[[File:ControlPointProperties.JPG|700px]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

[[File:SinglePlayerCheats.JPG|700px]]

[[File:CapturePointCaptureResults.JPG|700px]]

[[File:CapturePointGeo.JPG]]

File:CapturePointGeo.JPG

2020-06-14T17:49:39Z

Ecnassianer: Ecnassianer uploaded a new version of File:CapturePointGeo.JPG

Properties

2020-06-14T17:48:28Z

Ecnassianer:

File:CapturePointGeo.JPG

2020-06-14T17:48:18Z

Ecnassianer:

File:CapturePointCaptureResults.JPG

2020-06-14T17:47:46Z

Ecnassianer:

File:SinglePlayerCheats.JPG

2020-06-14T17:47:25Z

Ecnassianer:

File:ControlPointProperties.JPG

2020-06-14T17:46:41Z

Ecnassianer:

Properties

2020-06-14T17:44:05Z

Ecnassianer:

==Control Point Teams==

[[File:ControlPointTeams.JPG|700px]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

Properties

2020-06-14T17:43:25Z

Ecnassianer:

[[File:ControlPointTeams.JPG|700px]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

Properties

2020-06-14T17:43:18Z

Ecnassianer:

[[File:ControlPointTeams.JPG|500px]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

Properties

2020-06-14T17:43:09Z

Ecnassianer:

[[File:ControlPointTeams.JPG|970px]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

Properties

2020-06-14T17:42:58Z

Ecnassianer:

[[File:ControlPointTeams.JPG]]

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

'''ControlDrainPerSecond''': The rate at which control drains when no one is on the point.

File:ControlPointTeams.JPG

2020-06-14T17:42:48Z

Ecnassianer:

Overriding Team Management

2020-06-14T17:41:03Z

Ecnassianer:

If you already have teams being assigned on your own, you can easily inherit from the capture point and override the Control Point Teams section, and provide that data however you want.

[[File:OverrideTeams.JPG|970px]]

This function isn't actually used by the Control Point, so you can change the signature however you want, just implement the method so it takes whatever format of teams you pass in and inserts that into the teams array appropriately.

Overriding Team Management

2020-06-14T17:39:59Z

Ecnassianer:

Overriding Team Management

2020-06-14T17:39:49Z

Ecnassianer:

Overriding Team Management

2020-06-14T17:39:21Z

Ecnassianer:

Overriding Team Management

2020-06-14T17:39:06Z

Ecnassianer: