Why use it
The boolean result makes success, availability or state explicit without exceptions.
EPOK RUNTIME
epok::SceneLibrary::set_fog
Method · 1 overload
Method
Sets fog as part of the gameplay api module.
Declaration
staticDeclaration
static bool set_fog(FogSettings value)Sets fog as part of the gameplay api module.
| Parameter | Type | Meaning |
|---|---|---|
value | FogSettings | Value supplied for value. Keep referenced or pointed-to data valid for the complete call. |
Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "gameplay_api.hpp"
// Assume these named values have been initialized with valid data:
// FogSettings value
auto result = epok::SceneLibrary::set_fog(value);Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations.
Declared in runtime/gameplay_api.hpp:275
Related members
active_camera_actorPerforms `active camera actor` as part of the gameplay api module.MethodfogPerforms `fog` as part of the gameplay api module.MethodprojectPerforms `project` as part of the gameplay api module.MethodrequestRequests request as part of the gameplay api module.Methodrequest_with_transitionRequests with transition as part of the gameplay api module.Methodscreen_fadeThe post-HUD fade to black, 0 clear to 255 opaque, clamped rather than rejected because every amount above the range has one nearest valid value.Methodset_cameraSets camera as part of the gameplay api module.Methodset_screen_fadeSets screen fade as part of the gameplay api module.MethodsnapshotPerforms `snapshot` as part of the gameplay api module.Methodtransition_snapshotPerforms `transition snapshot` as part of the gameplay api module.Method