Source.Python/docs/_modules/settings/types.html at v743 · Source-Python-Dev-Team/Source.Python

History

505 lines (402 loc) · 56.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

<!DOCTYPE html>

<head>

<title>settings.types — Source.Python v742 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">settings.types</a></li>

</ul>

</div>

<h1>Source code for settings.types</h1><div class="highlight"><pre>

# ../settings/types.py

"""Contains user setting types."""

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python

from collections import OrderedDict

# Source.Python

from cvars import ConVar

from engines.server import engine_server

from menus import PagedMenu, SimpleMenu

from menus import PagedOption, SimpleOption

from messages import SayText

from players.entity import Player

from players.helpers import uniqueid_from_index

from settings import _settings_strings

from settings.storage import _player_settings_storage

from translations.strings import TranslationStrings

# =============================================================================

# >> GLOBAL VARIABLES

# =============================================================================

_message = SayText(message=_settings_strings['Chosen'])

# =============================================================================

# >> CLASSES

# =============================================================================

class SettingsType(object):

"""Class used to store settings with possible values."""

prefix = ''

def __new__(cls, name, default, text=None, *args):

"""Verify the name and default value before getting the new object."""

# Was a valid value passed as the name?

if not name.replace('_', '').replace(' ', '').isalpha():

# Raise an error

raise ValueError(

'Given name "{0}" is not valid'.format(name))

# Is the given default value of the correct type?

if not isinstance(default, cls._type):

# Raise an error

raise ValueError(

'Given value must be of "{0}" type, not "{1}"'.format(

cls._type.__name__, type(default).__name__))

# Get the new object instance

self = object.__new__(cls)

# Return the instance

return self

def __init__(self, name, default, text=None):

"""Store the base attributes and create the menu."""

self.name = name

self.default = default

self.text = text

self._create_menu()</div>

def _create_menu(self):

self.menu = PagedMenu(

select_callback=self._chosen_value,

build_callback=self._menu_build,

title=self.name if self.text is None else self.text,

description=_settings_strings['Description']

)

@property

def convar(self):

"""Return the convar name of the setting.

:rtype: str

"""

return self.prefix + self.name.lower().replace(' ', '_')

@property

def _type(self):

"""The type of object to cast values to for the class."""

raise NotImplementedError('No _type defined for class.')

def _is_valid_setting(self, value):

"""Return whether or not the given value is valid."""

raise NotImplementedError('No _is_valid_setting defined for class.')

def get_setting(self, index):

"""Return the setting value for the given player index."""

if Player(index).is_fake_client():

return self._get_default_value()

# Get the client's convar value

value = engine_server.get_client_convar_value(index, self.convar)

# Try to typecast the value, suppressing ValueErrors

try:

# Typecast the given value

value = self._typecast_value(value)

# Is the given value a proper one for the convar?

if self._is_valid_setting(value):

# If so, return the value

return value

except ValueError:

pass

# Get the client's uniqueid

uniqueid = uniqueid_from_index(index)

# Is the uniqueid in the setting's storage dictionary?

if uniqueid in _player_settings_storage:

# Is the convar in the clients's dictionary?

if self.convar in _player_settings_storage[uniqueid]:

# Get the client's value for the convar

value = _player_settings_storage[uniqueid][self.convar]

# Try to typecast the value, suppressing ValueErrors

try:

# Typecast the given value

# Is the given value a proper one for the convar?

if self._is_valid_setting(value):

# Return the value

return value

except ValueError:

pass

# Return the default value

return self._get_default_value()</div>

def _get_default_value(self):

if isinstance(self.default, ConVar):

return self._typecast_default_convar()

return self.default

def _typecast_value(self, value):

"""Cast the value to the proper type."""

return self._type(value)

def _typecast_default_convar(self):

"""Return the type-casted value of the default ConVar."""

return getattr(

self.default,

'get_{value_type}'.format(

value_type=str(self._type)

)

)()

def _menu_build(self, menu, index):

"""Set the default value in the menu description."""

self.menu.description.tokens = {'value': self.get_setting(index)}

def _chosen_value(self, menu, index, option):

"""Store the player's chosen value for the setting."""

# Set the player's setting

uniqueid = uniqueid_from_index(index)

_player_settings_storage[uniqueid][self.convar] = option.value

self._send_chosen_message(index, option.value)

def _send_chosen_message(self, index, value):

"""Send message about choice made for setting change."""

_message.send(index, convar=self.convar, value=value)</div>

class IntegerSetting(SettingsType):

"""Class used to store integer value settings."""

_type = int

def __init__(

self, name, default, text=None, min_value=None, max_value=None

):

"""Store the base attributes on instantiation."""

super().__init__(name, default, text)

if min_value is not None and max_value is not None:

if min_value >= max_value:

raise ValueError(

'min_value ({min_value}) must be less than max_value '

'({max_value}).'.format(

min_value=min_value,

max_value=max_value,

)

self.min = self._type(min_value) if min_value is not None else None

self.max = self._type(max_value) if max_value is not None else None

self.current_values = {}</div>

def _create_menu(self):

self.menu = SimpleMenu(

select_callback=self._chosen_value,

build_callback=self._menu_build,

)

"""Build the menu."""

self.menu.clear()

self.menu.append(self.name if self.text is None else self.text)

# Get the player's information

player = Player(index)

uniqueid = player.uniqueid

current_value = self.get_setting(index)

description = _settings_strings['Description'].get_string(

language=player.language,

value=current_value,

)

counter = 1

if self.min is None or self.max is None or self.max - self.min > 100:

for value in (100, -100):

self._add_option(choice_index=counter, value=value)

counter += 1

for value in (10, -10):

counter += 1

for value in (1, -1):

counter += 1

if uniqueid not in self.current_values:

self.current_values[uniqueid] = current_value

self.menu.append(

SimpleOption(

choice_index=counter,

text='Save ({current_value})'.format(

current_value=self.current_values[uniqueid],

),

value='Save',

)

def _add_option(self, choice_index, value):

"""Add the value to the menu."""

self.menu.append(

SimpleOption(

choice_index=choice_index,

text='{:+d}'.format(value),

value=value,

)

"""Store the player's chosen value for the setting."""

uniqueid = uniqueid_from_index(index)

if option.value == 'Save':

value = self.current_values[uniqueid]

# Set the player's setting

del self.current_values[uniqueid]

return

new_value = self.current_values[uniqueid] + option.value

new_value = max(new_value, self.min)

new_value = min(new_value, self.max)

self.menu.send()

"""Return whether the given value is a valid value for the setting."""

# Is the given value less than the setting's min value?

if self.min is not None and value < self.min:

# If too low, return False

return False

# Is the given value more than the setting's max value?

if self.max is not None and value > self.max:

# If too high, return False

return False

# Return True if the value is within the proper range

return True</div>

class BoolSetting(SettingsType):

"""Class used to store boolean value settings."""

_type = bool

for item in [True, False]:

self.menu.append(

PagedOption(

text=item,

value=item,

)

)</div>

"""Cast the given value to a boolean."""

try:

value = int(value)

return bool(value)

except ValueError:

return ''

"""Return whether the given value is a valid boolean value."""

return isinstance(value, self._type)</div>

class StringSetting(SettingsType):

"""Class used to store string value settings with available options."""

_type = str

"""Store the base attributes on instatiation."""

self.options = OrderedDict()</div>

def add_option(self, name, text=None):

"""Add an option to the setting's dictionary."""

# Is the given option already registered?

if name in self.options:

# Raise an error

raise ValueError(

'Given name "{0}" is already an option'.format(name))

# Store the option

option = self.options[name] = PagedOption(

text=name if text is None else text,

value=name,

)

# Add the option to the menu

def remove_option(self, name):

"""Remove an option from the settings."""

# Is the option registered?

if name not in self.options:

# Raise an error

raise ValueError(

'Given name "{0}" is not an option'.format(name))

# Delete the option

self.menu.remove(self.options[name])

del self.options[name]</div>

"""Return whether the given value is a valid value for the setting."""

# Is the given value in the setting's options?

if value in self.options:

# If so, return True

return True

# If the given value is not in the options, return False

return False

"""Send message about choice made for setting change."""

value = self.options[value].text

if isinstance(value, TranslationStrings):

player = Player(index)

value = value.get_string(player.language)

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">settings.types</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

types.html

Latest commit

History

types.html

File metadata and controls