Sigonasr2: Create API Function Page. Include Example.

2011-10-19T06:25:15Z

Create API Function Page. Include Example.

New page

{{apicall
| name = bz_setBZDBString
| returns = Whether or not the set was successful.
| returntype = bool
| description = Sets a BZDB variable to a given '''string''' value.
| param1 = variable
| param1type = const char*
| param1desc = Variable name (E.g. "_shockOutRadius")
| param2 = val
| param2type = const char*
| param2desc = The value to set the variable to.
| param3 = perms = 0
| param3type = int
| param3desc = What to set the permission value to. (Range: 1-3. Using 0 sets it to the default [2], and using a higher number sets it to 3.)
| param4 = persistent = false
| param4type = bool
| param4desc = Whether or not the variable will be persistent.
}}
===Example===
Sets the fog color to a light white color.
bz_setBZDBString("_fogColor","0.8 0.8 0.8");

Bz setBZDBString - Revision history

Sigonasr2: Create API Function Page. Include Example.