BP Compendium 3: Execute Console Command

Execute Console Command

Blueprint function that allows the execution of a console command. Console commands are text-based commands that can be executed in the editor or in the game.

Input

• Command: Console command that will be executed.
• Specific Player: Optional. Reference to a Player Controller that will receive the command.

Example Usage: 

In a simple game, the level will be restarted when the player dies. This is done using a custom event named "Death" that executes the console command "RestartLevel".

Click to enlarge

For a complete list of console commands, open the "Output Log" window (Window → Developer Tools → Output Log). The line at the bottom of the window is for entering console commands. Enter the "DumpConsoleCommands" command and press Enter to get the list of commands.

Click to enlarge

Table of Contents

Compêndio BP 3: Execute Console Command

Execute Console Command

Função blueprint que permite a execução de um comando de console. Comandos de console são comandos em formato texto que podem ser executados no editor ou dentro do jogo.

Entrada

• Command: Comando de console que será executado.
• Specific Player: Opcional. Referência a um Player Controller que receberá o comando.

Exemplo de uso: 

Em um jogo simples, o nível será reiniciado quando o jogador morrer. Isto foi feito usando um evento customizado com o nome "Death" que executa o comando de console "RestartLevel".

Clique para aumentar

Para obter uma lista completa dos comandos de console, abra a janela "Output Log" (Window→ Developer Tools → Output Log). A linha na parte de baixo da janela é para inserir comandos de console. Coloque o comando "DumpConsoleCommands" e pressione Enter para obter a lista de comandos.

Clique para aumentar

Sumário

BP Compendium 3: AI Move To

AI Move To

The "AI Move To" action is used to move a Pawn/Character. The destination can be a location or another actor. The level must have a "Nav Mesh Bounds Volume" to define the area that the "AI Move To" action can use. It is a latent action, so it runs in parallel to the normal flow of execution of the Blueprints.

Input

• Pawn: Reference to the Pawn/Character that will be moved.
• Destination: Vector indicating the destination.
• Target Actor: Reference to an actor to be used as destination.
• Acceptance Radius: Maximum destination distance to complete movement.
• Stop on Overlap: Boolean value. If true, complete the move as soon as the Pawn begins to overlap the "Acceptance Radius".

Output

• On Success: Execution pin that will be activated when and if the "AI Move To" manages to reach the target.
• On Fail: Execution pin that will be activated if the destination can not be reached.
• Movement Result: Enumeration that indicates the result of the movement.

Example Usage: 

The image shows the "AI Move To" action being used for a Pawn to follow a path represented by a set of predefined points on the level. These points representing the path may be stored in an array. The "FindNextPoint" macro is responsible for picking the next point in the path and storing it in the "Next Point" variable.

Click to enlarge

The clock icon indicates that "AI Move To" is a latent action. The event "GoNextPoint" starts the "AI Move To" action, but only when the Pawn reach the destination is that the actions connected to the pin "On Success" will be performed. After the "FindNextPoint" macro updates the "Next Point" variable, the "GoNextPoint" event is called again.

Table of Contents

Compêndio BP 3: AI Move To

AI Move To

A ação "AI Move To" é usada para movimentar um ator do tipo Pawn/Character. O destino pode ser uma posição ou outro ator. É necessário ter um "Nav Mesh Bounds Volume" no cenário para definir a área que a ação "AI Move To" pode usar. Ela é uma ação latente, ou seja, executa em paralelo ao fluxo normal dos blueprints.

Entrada

• Pawn: Referência ao Pawn/Character que será movido.
• Destination: Vetor indicando o destino.
• Target Actor: Referência a um ator que será usado como destino. 
• Acceptance Radius: Distância máxima do destino para concluir o movimento.
• Stop on Overlap: Valor booleano. Se for verdadeiro, conclui o movimento assim que o Pawn começar a sobrepor o "Acceptance Radius". 

Saída

• On Success: Pino de execução que será ativado quando e se o "AI Move To" conseguir chegar no destino.
• On Fail: Pino de execução que será ativado se não for possível chegar ao destino.
• Movement Result: Enumeração que indica o resultado do movimento.

Exemplo de uso: 

A imagem mostra a ação "AI Move To" sendo usada para que um Pawn siga um caminho representado por um conjunto de pontos predefinidos no cenário. Estes pontos que representam o caminho podem estar armazenados em um array. A macro "FindNextPoint" é responsável por pegar o próximo ponto do caminho e armazenar na variável "Next Point". 

Clique para aumentar

O ícone do relógio indica que "AI Move To" é uma ação latente. O evento "GoNextPoint" inicia a ação "AI Move To", mas somente quando o Pawn chegar no destino é que as ações ligadas ao pino "On Success" serão executadas. Depois que a macro "FindNextPoint" atualiza a variável "Next Point" o evento "Go Next Point" é chamado novamente.

Sumário

BP Compendium 3: Spawn Emitter at Location

Spawn Emitter at Location

Plays a particle system at the specified location.

Input

• Emitter Template: Particle system template that will be used.
• Location: Location where the particle system will be created.
• Rotation: Rotation used by the particle system. 
• Auto Destroy: Boolean value. If true, it destroys the particle system when execution is complete.

Output

• Return Value: Reference to the particle system component that was created.

Example Usage: 

The image below is from a blueprint that represents a "Bullet". When this bullet collides with something a particle system will be created at the collision location using the "P_Explosion" template. After this the bullet is destroyed.

Click to enlarge

In another example, a particle system is created when an actor overlaps a blueprint and is destroyed when an actor ends the overlap. The reference to the particle system created is saved in the "Emitter Reference" variable. The particle system template "P_Sparks" that was used is looped and does not stop running automatically.

Click to enlarge

Table of Contents

Compêndio BP 3: Spawn Emitter at Location

Spawn Emitter at Location

Executa um sistema de partículas na localização especificada.

Entrada

• Emitter Template: Modelo de sistema de partículas que será utilizado.
• Location: Posição onde será criado o sistema de partículas.
• Rotation: Rotação usada pelo sistema de partículas. 
• Auto Destroy: Valor booleano. Se for verdadeiro, destrói o sistema de partículas quando a execução for concluída.

Saída

• Return Value: Referência ao componente de sistema de partículas que foi criado.

Exemplo de uso: 

A imagem abaixo é de um blueprint que representa uma "Bala". Quando esta bala colidir com algum obstáculo será criado no local da colisão um sistema de partículas usando como modelo o "P_Explosion". Depois disto a bala é destruída.

Clique para aumentar

Em outro exemplo, um sistema de partículas é criado quando um ator sobrepõe um blueprint e é destruído quando um ator encerra a sobreposição. A referência para o sistema de partícula criado é salva na variável "Emitter Reference". O modelo de sistema de partículas "P_Sparks" que foi usado se mantém em loop e não encerra sua execução automaticamente.

Clique para aumentar

Sumário

BP Compendium 3: Add Child Actor Component

Add Child Actor Component

Adds an Actor as a component of another Actor. Thus the component actor follows the transformations of the parent Actor. When the parent Actor is destroyed, the Actor component will also be destroyed. The new actor's class must be specified in the "Details" tab of the "Add Child Actor Component" function.

Input

• Target:  Reference to the Actor who will own the new component.
• Manual Attachment: Boolean value. If false, the new Actor will be automatically attached. 
• Relative Transform: Transformation used by the new component.

Output

• Return Value: Reference to the created Actor.

Example Usage: 

In this example we have a blueprint that represents a weapon. The name of this blueprint is "WeaponBlueprint". In another blueprint that represents a character of the game there is an event that will be called during the game to add a weapon of type "WeaponBlueprint" to the character.

Click to enlarge

The image below shows the "Details" tab of the "Add Child Actor Component" function that is displayed when the function is selected. The class that will be used by the new actor must be informed in the "Child Actor Class" property.

Table of Contents