跳轉到

Class gridpp::Overlay

ClassList > gridpp > Overlay

操作繪製在遊戲世界上方的畫面覆蓋元素。 More...

  • #include <Overlay.h>

Public Functions

Type Name
Overlay () = default
建立不指向任何元素的 handler。
Overlay deepCopy () const
bool exists () const
int get (const std::string & key, int & value) const
int get (const std::string & key, long long & value) const
int get (const std::string & key, double & value) const
int get (const std::string & key, bool & value) const
int get (const std::string & key, std::string & value) const
int get (const std::string & key, std::vector< T > & value) const
void hide ()
隱藏元素；隱藏期間仍會執行更新 callback，但按鈕不會接受點擊。
std::string image () const
void move (int dx, int dy)
將元素相對移動 dx、dy 像素。
void remove ()
從引擎移除元素；呼叫後所有指向它的 handler 都會失效。
void set (const std::string & key, int value)
以 key 儲存整數；int 與 long long 都以 long long 保存。
void set (const std::string & key, long long value)
以 key 儲存長整數。
void set (const std::string & key, double value)
以 key 儲存浮點數。
void set (const std::string & key, bool value)
以 key 儲存布林值。
void set (const std::string & key, const std::string & value)
以 key 儲存字串。
void set (const std::string & key, const char * value)
以 key 儲存 C 字串；內部會複製為 std::string。
void set (const std::string & key, const std::vector< T > & value)
以 key 儲存指定類型的 vector。
void setClickFunction (OverlayCallback function)
取代按鈕點擊 callback。
void setColor (Color color)
設定圖片 tint、文字顏色或按鈕文字顏色。
void setImage (const std::string & image)
設定圖片覆蓋元件的素材名稱。
void setInitFunction (OverlayCallback function)
取代初始化 callback；若元件已初始化，新函式不會自動補呼叫。
void setPosition (int x, int y)
將元素移到指定像素座標。
void setText (const std::string & text)
設定文字覆蓋元件或按鈕的文字。
void setUpdateFunction (OverlayCallback function)
取代每幀更新 callback。
void show ()
顯示元素。
std::string text () const
bool visible () const
int x () const
int y () const

Detailed Description

Overlay 使用視窗像素座標。複製 handler 不會複製元素；所有複本仍操作同一個實體。 除 exists() 之外，對已移除或引擎已銷毀的 handler 呼叫其他函式會拋出 std::runtime_error。

Public Functions Documentation

function Overlay

建立不指向任何元素的 handler。 

gridpp::Overlay::Overlay () = default

function deepCopy

inline Overlay gridpp::Overlay::deepCopy () const

Returns:

一個擁有獨立狀態、callback 與新 handler 的元素複本。

function exists

inline bool gridpp::Overlay::exists () const

Returns:

handler 是否仍指向存在的元素。

function get [1/6]

inline int gridpp::Overlay::get (
    const std::string & key,
    int & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為預設值並回傳 1。

Exception:

  • std::runtime_error 若類型不同，或儲存的整數無法容納於 int。

function get [2/6]

inline int gridpp::Overlay::get (
    const std::string & key,
    long long & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為預設值並回傳 1。

Exception:

  • std::runtime_error 若取值類型與儲存類型不同。

function get [3/6]

inline int gridpp::Overlay::get (
    const std::string & key,
    double & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為預設值並回傳 1。

Exception:

  • std::runtime_error 若取值類型與儲存類型不同。

function get [4/6]

inline int gridpp::Overlay::get (
    const std::string & key,
    bool & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為預設值並回傳 1。

Exception:

  • std::runtime_error 若取值類型與儲存類型不同。

function get [5/6]

inline int gridpp::Overlay::get (
    const std::string & key,
    std::string & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為預設值並回傳 1。

Exception:

  • std::runtime_error 若取值類型與儲存類型不同。

function get [6/6]

template<typename T>
inline int gridpp::Overlay::get (
    const std::string & key,
    std::vector< T > & value
) const

Returns:

找到 key 時為 0；找不到時將 value 清為空 vector 並回傳 1。

Exception:

  • std::runtime_error 若取值類型與儲存類型不同。

function hide

隱藏元素；隱藏期間仍會執行更新 callback，但按鈕不會接受點擊。 

inline void gridpp::Overlay::hide ()

function image

inline std::string gridpp::Overlay::image () const

Returns:

圖片覆蓋元件的素材名稱。

Exception:

  • std::runtime_error 若此 handler 指向文字或按鈕。

function move

將元素相對移動 dx、dy 像素。 

inline void gridpp::Overlay::move (
    int dx,
    int dy
)

function remove

從引擎移除元素；呼叫後所有指向它的 handler 都會失效。 

inline void gridpp::Overlay::remove ()

function set [1/7]

以 key 儲存整數；int 與 long long 都以 long long 保存。 

inline void gridpp::Overlay::set (
    const std::string & key,
    int value
)

function set [2/7]

以 key 儲存長整數。 

inline void gridpp::Overlay::set (
    const std::string & key,
    long long value
)

function set [3/7]

以 key 儲存浮點數。 

inline void gridpp::Overlay::set (
    const std::string & key,
    double value
)

function set [4/7]

以 key 儲存布林值。 

inline void gridpp::Overlay::set (
    const std::string & key,
    bool value
)

function set [5/7]

以 key 儲存字串。 

inline void gridpp::Overlay::set (
    const std::string & key,
    const std::string & value
)

function set [6/7]

以 key 儲存 C 字串；內部會複製為 std::string。 

inline void gridpp::Overlay::set (
    const std::string & key,
    const char * value
)

function set [7/7]

以 key 儲存指定類型的 vector。 

template<typename T>
inline void gridpp::Overlay::set (
    const std::string & key,
    const std::vector< T > & value
)

function setClickFunction

取代按鈕點擊 callback。 

inline void gridpp::Overlay::setClickFunction (
    OverlayCallback function
)

Exception:

  • std::runtime_error 若此 handler 不是按鈕。

function setColor

設定圖片 tint、文字顏色或按鈕文字顏色。 

inline void gridpp::Overlay::setColor (
    Color color
)

function setImage

設定圖片覆蓋元件的素材名稱。 

inline void gridpp::Overlay::setImage (
    const std::string & image
)

Exception:

  • std::runtime_error 若此 handler 指向文字或按鈕。

function setInitFunction

取代初始化 callback；若元件已初始化，新函式不會自動補呼叫。 

inline void gridpp::Overlay::setInitFunction (
    OverlayCallback function
)

function setPosition

將元素移到指定像素座標。 

inline void gridpp::Overlay::setPosition (
    int x,
    int y
)

function setText

設定文字覆蓋元件或按鈕的文字。 

inline void gridpp::Overlay::setText (
    const std::string & text
)

Exception:

  • std::runtime_error 若此 handler 指向圖片。

function setUpdateFunction

取代每幀更新 callback。 

inline void gridpp::Overlay::setUpdateFunction (
    OverlayCallback function
)

function show

顯示元素。 

inline void gridpp::Overlay::show ()

function text

inline std::string gridpp::Overlay::text () const

Returns:

文字覆蓋元件或按鈕的文字。

Exception:

  • std::runtime_error 若此 handler 指向圖片。

function visible

inline bool gridpp::Overlay::visible () const

Returns:

元素是否可見。

function x

inline int gridpp::Overlay::x () const

Returns:

元素的視窗像素 x 座標。

function y

inline int gridpp::Overlay::y () const

Returns:

元素的視窗像素 y 座標。

The documentation for this class was generated from the following file Overlay.h