Function disable

Summary

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

(1) Self & disable()

(2) Self & disable(flecs::id_t id)

(3) template <typename T>
    Self & disable()

(4) Self & disable(flecs::id_t first, flecs::id_t second)

(5) template <typename First>
    Self & disable(flecs::id_t second)

(6) template <typename First, typename Second>
    Self & disable()

Function overload

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

Self & disable()

Description

Disable an entity. Disabled entities are not matched with systems and cannot be searched with queries, unless explicitly specified in the query expression.

Source

Lines 481-484 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

Self& disable() {
    ecs_enable(this->m_world, this->m_id, false);
    return to_base();
}

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

Self & disable(flecs::id_t id)

Description

Disable an id. This sets the enabled bit for this id. If this is the first time the id is enabled or disabled, the bitset is added.

Parameters

id - The id to disable.

Source

Lines 546-548 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

Self& disable(flecs::id_t id) {
    return this->enable(id, false);
}

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

template <typename T>
Self & disable()

Description

Disable a component.

See
disable(flecs::id_t id)
Template Parameters

T - The component to enable.

Source

Lines 555-558 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

template<typename T>
Self& disable() {
    return this->disable(_::cpp_type<T>::id());
}

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

Self & disable(flecs::id_t first, flecs::id_t second)

Description

Disable a pair.

See
disable(flecs::id_t id)
Parameters

first - The first element of the pair.

second - The second element of the pair.

Source

Lines 566-568 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

Self& disable(flecs::id_t first, flecs::id_t second) {
    return this->disable(ecs_pair(first, second));
}

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

template <typename First>
Self & disable(flecs::id_t second)

Description

Disable a pair.

See
disable(flecs::id_t id)
Template Parameters

First - The first element of the pair.

Parameters

second - The second element of the pair.

Source

Lines 576-579 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

template<typename First>
Self& disable(flecs::id_t second) {
    return this->disable(_::cpp_type<First>::id(), second);
}

Synopsis

#include <include/flecs/addons/cpp/mixins/entity/builder.hpp>

template <typename First, typename Second>
Self & disable()

Description

Disable a pair.

See
disable(flecs::id_t id)
Template Parameters

First - The first element of the pair.

Second - The second element of the pair.

Source

Lines 587-590 in include/flecs/addons/cpp/mixins/entity/builder.hpp.

template<typename First, typename Second>
Self& disable() {
    return this->disable<First>(_::cpp_type<Second>::id());
}