Unravel Engine C++ Reference
Loading...
Searching...
No Matches
seq::seq_scope_policy Struct Reference

Defines policies for scoping actions in a sequence. More...

#include <seq_common.h>

Public Types

enum class  policy_t { stacked , independent }
 Represents the policy for scoping actions. More...
 

Public Member Functions

 seq_scope_policy () noexcept=default
 Default constructor.
 
 seq_scope_policy (const char *_scope) noexcept
 Constructs a scope policy with a specified scope.
 
 seq_scope_policy (const std::string &_scope) noexcept
 Constructs a scope policy with a specified scope.
 

Public Attributes

std::string scope
 The name of the scope.
 
policy_t policy = policy_t::stacked
 The scoping policy (default is stacked).
 

Detailed Description

Defines policies for scoping actions in a sequence.

Definition at line 91 of file seq_common.h.

Member Enumeration Documentation

◆ policy_t

Represents the policy for scoping actions.

Enumerator
stacked 

Actions share the same scope and stack behavior.

independent 

Actions operate independently within their scope.

Definition at line 97 of file seq_common.h.

Constructor & Destructor Documentation

◆ seq_scope_policy() [1/3]

seq::seq_scope_policy::seq_scope_policy ( )
defaultnoexcept

Default constructor.

◆ seq_scope_policy() [2/3]

seq::seq_scope_policy::seq_scope_policy ( const char * _scope)
inlinenoexcept

Constructs a scope policy with a specified scope.

Parameters
_scopeThe name of the scope.

Definition at line 122 of file seq_common.h.

◆ seq_scope_policy() [3/3]

seq::seq_scope_policy::seq_scope_policy ( const std::string & _scope)
inlinenoexcept

Constructs a scope policy with a specified scope.

Parameters
_scopeThe name of the scope as a string.

Definition at line 130 of file seq_common.h.

Member Data Documentation

◆ policy

policy_t seq::seq_scope_policy::policy = policy_t::stacked

The scoping policy (default is stacked).

Definition at line 111 of file seq_common.h.

◆ scope

std::string seq::seq_scope_policy::scope

The name of the scope.

Definition at line 106 of file seq_common.h.


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