Scripting.md

Scripting

Occasionally, you want to create additional gameplay (especially when creating a story campaign). This section highlights additional functions you can call from blueprints, as well as events you may handle.

Feel free to explore the plugin yourself by looking at what other functions and events each component provides, and open an issue if you're missing something.

Also note that much gameplay of the plugin relies on Gameplay Tags as defined by Content\Data\DT_RTSGameplayTags.uasset. This enables you to create unique gameplay and abilities by applying/removing these tags to/from the URTSGameplayTagsComponent of your actors. Initially, many of the plugin components apply matching gameplay tags (e.g. Status.Permanent.CanAttack from RTSAttackComponent). When creating your own actor components, you can derive from RTSActorComponent to provide your own Initial Gameplay Tags as well. The plugin also provides an own Gameplay Debugger category for checking the gameplay tags of selected actors.

RTSBountyComponent

Events

Event	Description
	Event when the bounty was collected.

RTSContainerComponent

Functions

Node	Description
	Adds the specified actor to this container.
	Removes the specified actor from this container.

RTSConstructionSiteComponent

Events

Event	Description
	Event when the construction timer has expired.

RTSGameMode

Functions

Node	Description
	Sets the specified player as the owner of the passed actor.

RTSGameplayLibrary

Functions

Node	Description
	Checks whether Other is visible for Actor.

RTSGameplayTagLibrary

Functions

Node	Description
	Applies the passed gameplay tag to the specified actor.
	Gets the current set of gameplay tags of the specified actor.
	Checks whether the specified actor currently has the passed gameplay tag applied.
	Removes the passed gameplay tag from the specified actor.

RTSHealthComponent

Events

Event	Description
	Event when the current health of the actor has changed.
	Event when the actor has been killed.

RTSPawnAIController

Functions

Node	Description
	Makes the pawn carry out the specified order.
	Makes the pawn attack the specified target.
	Makes the pawn construct the specified building at the passed location.
	Makes the pawn gather resources from the specified source.
	Makes the pawn move towards the specified location.
	Makes the pawn stop all actions immediately.

Events

Event	Description
	Event when the pawn has received a new order.

RTSPlayerController

Events

Event	Description
	Event when the player state has been set up or replicated for this player.

RTSPlayerResourcesComponent

Functions

Node	Description
	Adds the specified resources to the stock of this player.

Events

Event	Description
	Event when the current resource stock amount for the player has changed.

RTSPlayerController

Functions

Node	Description
	Gets the list of actors currently owned by this player.

RTSProductionComponent

Events

Event	Description
	Event when the production timer has expired.