Open 3D Engine ScriptCanvas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
ScriptCanvas::ParserValidation Class Reference

#include <ParsingValidations.h>

Inherits ScriptCanvas::ValidationEvent, ScriptCanvas::HighlightEntityEffect, and ScriptCanvas::FocusOnEntityEffect.

Inherited by ScriptCanvas::InactiveGraph, ScriptCanvas::Internal::AddOutputNameFailure, ScriptCanvas::Internal::DuplicateInputProcessed, ScriptCanvas::Internal::NullEntityInGraph, ScriptCanvas::Internal::NullNodeInGraph, ScriptCanvas::Internal::ParseError, ScriptCanvas::MultipleExecutionOutConnections, ScriptCanvas::MultipleStartNodes, ScriptCanvas::NodeCompatiliblity::DependencyRetrievalFailiure, ScriptCanvas::NodeCompatiliblity::NodeOutOfDate, and ScriptCanvas::NotYetImplemented.

Public Member Functions

 AZ_RTTI (ParserValidation, "{1B91C6DC-B258-463C-B7EE-05338F6635E2}", ValidationEvent, HighlightEntityEffect, FocusOnEntityEffect)
 
 AZ_CLASS_ALLOCATOR (ParserValidation, AZ::SystemAllocator)
 
 ParserValidation (AZ::EntityId nodeId, ValidationSeverity severity, const AZStd::string_view &description, AZ::Crc32 idCRC={}, const AZStd::string &id={})
 
AZStd::string GetIdentifier () const override
 
AZ::Crc32 GetIdCrc () const override
 
AZStd::string_view GetTooltip () const override
 
AZ::EntityId GetHighlightTarget () const override
 
AZ::EntityId GetFocusTarget () const override
 
- Public Member Functions inherited from ScriptCanvas::ValidationEvent
 AZ_RTTI (ValidationEvent, "{58F76284-987C-4A15-A31B-407475586958}")
 
 AZ_CLASS_ALLOCATOR (ValidationEvent, AZ::SystemAllocator)
 
void SetDescription (AZStd::string_view description)
 
AZStd::string_view GetDescription () const
 
virtual bool CanAutoFix () const
 
virtual AZStd::string GetIdentifier () const =0
 
virtual AZ::Crc32 GetIdCrc () const =0
 
virtual AZStd::string_view GetTooltip () const =0
 
ValidationSeverity GetSeverity () const
 
- Public Member Functions inherited from ScriptCanvas::HighlightEntityEffect
 AZ_RTTI (HighlightEntityEffect, "{20EA6019-5F3C-43C5-88AF-6F4BF840B2D2}")
 
 AZ_CLASS_ALLOCATOR (HighlightEntityEffect, AZ::SystemAllocator)
 
virtual AZ::EntityId GetHighlightTarget () const =0
 
- Public Member Functions inherited from ScriptCanvas::FocusOnEntityEffect
 AZ_RTTI (FocusOnEntityEffect, "{583D7B85-6088-4C44-A254-70B04F294BB4}")
 
 AZ_CLASS_ALLOCATOR (FocusOnEntityEffect, AZ::SystemAllocator)
 
virtual AZ::EntityId GetFocusTarget () const =0
 

Additional Inherited Members

- Protected Member Functions inherited from ScriptCanvas::ValidationEvent
 ValidationEvent (const ValidationSeverity &validationType)
 
void SetValidationType (const ValidationSeverity &validationType)
 

Detailed Description

Base class for all parser validation events, they will all share the same behavior

Member Function Documentation

◆ GetFocusTarget()

AZ::EntityId ScriptCanvas::ParserValidation::GetFocusTarget ( ) const
inlineoverridevirtual

Implements ScriptCanvas::FocusOnEntityEffect.

◆ GetHighlightTarget()

AZ::EntityId ScriptCanvas::ParserValidation::GetHighlightTarget ( ) const
inlineoverridevirtual

Implements ScriptCanvas::HighlightEntityEffect.

◆ GetIdCrc()

AZ::Crc32 ScriptCanvas::ParserValidation::GetIdCrc ( ) const
inlineoverridevirtual

Implements ScriptCanvas::ValidationEvent.

◆ GetIdentifier()

AZStd::string ScriptCanvas::ParserValidation::GetIdentifier ( ) const
inlineoverridevirtual

Implements ScriptCanvas::ValidationEvent.

◆ GetTooltip()

AZStd::string_view ScriptCanvas::ParserValidation::GetTooltip ( ) const
inlineoverridevirtual

Implements ScriptCanvas::ValidationEvent.

The documentation for this class was generated from the following file: