Source.Python/docs/_modules/menus/radio.html at master · Source-Python-Dev-Team/Source.Python

History

545 lines (444 loc) · 56.8 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

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

<!DOCTYPE html>

<head>

<title>menus.radio — Source.Python v743 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 v743 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="">menus.radio</a></li>

</ul>

</div>

<h1>Source code for menus.radio</h1><div class="highlight"><pre>

# ../menus/radio.py

"""Provides ShowMenu based functionality."""

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

# >> IMPORTS

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

# Source.Python Imports

# Core

from core import SOURCE_ENGINE

# Menus

from menus.base import Text

from menus.base import _BaseMenu

from menus.base import _PagedMenuBase

from menus.base import _BaseOption

from menus.base import _format_paged_title

from menus.base import _translate_text

from menus.queue import _radio_queues

# Messages

from messages import ShowMenu

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

# >> ALL DECLARATION

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

__all__ = ('ListRadioMenu',

'ListRadioOption',

'PagedRadioMenu',

'PagedRadioOption',

'SimpleRadioMenu',

'SimpleRadioOption',

)

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

# >> CONSTANTS

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

if SOURCE_ENGINE in ('csgo', 'bms'):

BUTTON_BACK = 7

BUTTON_NEXT = 8

BUTTON_CLOSE = 9

BUTTON_CLOSE_SLOT = BUTTON_CLOSE

MAX_ITEM_COUNT = 6

VALID_CHOICES = range(1, 10)

else:

BUTTON_BACK = 8

BUTTON_NEXT = 9

BUTTON_CLOSE = 10

BUTTON_CLOSE_SLOT = 0

MAX_ITEM_COUNT = 7

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

# >> CLASSES

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

class SimpleRadioMenu(_BaseMenu):

"""This class creates a basic radio menu."""

def _get_menu_data(self, player_index):

"""Return the menu string, enabled slots, and time to show the menu.

:param int player_index: See

:meth:`menus.base._BaseMenu._get_menu_data`.

"""

# Always enable BUTTON_CLOSE_SLOT

slots = {BUTTON_CLOSE_SLOT}

buffer = ''

page = self._player_pages[player_index]

page.options = {}

for raw_data in self:

# Handle Text objects

if isinstance(raw_data, Text):

buffer += raw_data._render(player_index)

# Handle _BaseOption objects

elif isinstance(raw_data, SimpleRadioOption):

if raw_data.selectable:

slots.add(raw_data.choice_index)

page.options[raw_data.choice_index] = raw_data

# Handle every other object type as a text

else:

buffer += Text(raw_data)._render(player_index)

# Return the menu data

return (buffer[:-1] if buffer else '', self._slots_to_bin(slots), 1)

@staticmethod

def _slots_to_bin(slots):

"""Convert an iterable of slots to the binary slot representation.

:param iterable slots: Slots that should be enabled.

:raise ValueError: Raised if a slot is out of range.

"""

# Keys are enabled in that order: 0987654321

buffer = list('0000000000')

for slot in slots:

if 0 <= slot <= 9:

buffer[~(slot - 1)] = '1'

else:

raise ValueError('Slot out of range: {}'.format(slot))

return int(''.join(buffer), 2)

def _select(self, player_index, choice_index):

"""See :meth:`menus.base._BaseMenu._select`."""

if choice_index == BUTTON_CLOSE:

return self._select_close(player_index)

try:

option = self._player_pages[player_index].options[choice_index]

except KeyError:

return

return super()._select(player_index, option)

def _send(self, player_index):

"""Build and sends the menu to the given player via ShowMenu.

:param int player_index: See :meth:`menus.base._BaseMenu._send`.

"""

ShowMenu(*self._build(player_index)).send(player_index)

@staticmethod

def _close(player_index):

"""See :meth:`menus.base._BaseMenu._close`."""

# Send an empty menu

ShowMenu('', 0b0000000000, 0).send(player_index)

@staticmethod

def _get_queue_holder():

"""Return the queue for radio menus."""

return _radio_queues</div>

class PagedRadioMenu(SimpleRadioMenu, _PagedMenuBase):

"""Create menus with an unlimited number of options.

Navigation options will be added automatically.

"""

def __init__(

build_callback=None, close_callback=None, description=None,

title=None, top_separator='-' * 30, bottom_separator='-' * 30,

fill=True, parent_menu=None, show_pages=True):

"""Initialize the object.

:param iterable|None data: See :meth:`menus.base._BaseMenu.__init__`.

:param callable|None select_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param callable|None build_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param callable|None close_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param str|None description: A description that is displayed under the

title.

:param str|None title: A title that is displayed at the top of the

menu.

:param str top_separator: A separator that is displayed right after

the title/description.

:param str bottom_separator: A separator that is displayed right after

the body.

:param bool fill: If True the menu will be filled so that it will

always have the same size.

:param _BaseMenu parent_menu: A menu that will be displayed when

hitting 'Back' on the first page.

"""

super().__init__(data, select_callback, build_callback, close_callback)

self.title = title

self.description = description

self.top_separator = top_separator

self.bottom_separator = bottom_separator

self.fill = fill

self.parent_menu = parent_menu

self.show_pages = show_pages</div>

@staticmethod

def _get_max_item_count():

"""Return the maximum possible item count per page."""

return MAX_ITEM_COUNT

def _format_header(self, player_index, page, slots):

"""Prepare the header for the menu.

:param int player_index: A player index.

:param _PlayerPage page: The player's current page.

:param slots: A set to which slots can be added.

:type slots: :class:`set`

"""

buffer = _format_paged_title(self, player_index, page)

if buffer:

buffer += '\n'

# Set description if present

if self.description is not None:

buffer += _translate_text(self.description, player_index) + '\n'

# Set the top separator if present

if self.top_separator is not None:

buffer += self.top_separator + '\n'

return buffer

def _format_body(self, player_index, page, slots):

"""Prepare the body for the menu.

:param int player_index: A player index.

:param _PlayerPage page: The player's current page.

:param slots: A set to which slots can be added.

:type slots: :class:`set`

"""

buffer = ''

# Get all options for the current page

options = tuple(enumerate(self._get_options(page.index), 1))

page.options = dict(options)

# Loop through all options of the current page

for choice_index, option in options:

if isinstance(option, PagedRadioOption):

buffer += option._render(player_index, choice_index)

if option.selectable:

slots.add(choice_index)

elif isinstance(option, Text):

else:

buffer += Text(option)._render(player_index, choice_index)

# Fill the rest of the menu

if self.fill:

buffer += ' \n' * (self._get_max_item_count() - len(options))

return buffer

def _format_footer(self, player_index, page, slots):

"""Prepare the footer for the menu.

:param int player_index: A player index.

:param _PlayerPage page: The player's current page.

:param slots: A set to which slots can be added.

:type slots: :class:`set`

"""

buffer = ''

# Set the bottom separator if present

if self.bottom_separator is not None:

buffer += self.bottom_separator + '\n'

# TODO: Add translations

# Add "Back" option

back_selectable = page.index > 0 or self.parent_menu is not None

buffer += PagedRadioOption(

'Back', highlight=back_selectable)._render(

player_index, BUTTON_BACK)

if back_selectable:

slots.add(BUTTON_BACK)

# Add "Next" option

next_selectable = page.index < self.last_page_index

buffer += PagedRadioOption(

'Next', highlight=next_selectable)._render(

player_index, BUTTON_NEXT)

if next_selectable:

slots.add(BUTTON_NEXT)

# Add "Close" option

buffer += PagedRadioOption(

'Close', highlight=False)._render(player_index, BUTTON_CLOSE_SLOT)

# Return the buffer

return buffer

"""Return all relevant menu data as a dictionary.

:param int player_index: A player index.

"""

# Get the player's current page

# Always enable BUTTON_CLOSE_SLOT

slots = {BUTTON_CLOSE_SLOT}

# Format the menu

buffer = self._format_header(player_index, page, slots)

buffer += self._format_body(player_index, page, slots)

buffer += self._format_footer(player_index, page, slots)

# Return the menu data

"""See :meth:`menus.base._BaseMenu._select`."""

if choice_index == BUTTON_CLOSE:

del self._player_pages[player_index]

# Get the player's current page

# Display previous page?

if choice_index == BUTTON_BACK:

# Is the player on the first page, and do we have a parent menu?

if not page.index and self.parent_menu is not None:

return self.parent_menu

self.set_player_page(player_index, page.index - 1)

return self

# Display next page?

if choice_index == BUTTON_NEXT:

self.set_player_page(player_index, page.index + 1)

return self

class ListRadioMenu(PagedRadioMenu):

"""Creates a list-like radio menu.

Navigation options are added automatically."""

def __init__(

self, data=None, select_callback=None, build_callback=None, close_callback=None,

description=None, title=None, top_separator='-' * 30,

bottom_separator='-' * 30, fill=True, parent_menu=None,

items_per_page=10, show_pages=True):

"""Initialize the object.

:param iterable|None data: See :meth:`menus.base._BaseMenu.__init__`.

:param callable|None select_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param callable|None build_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param callable|None close_callback: See

:meth:`menus.base._BaseMenu.__init__`.

:param str|None description: See :meth:`PagedRadioMenu.__init__`.

:param str|None title: See :meth:`PagedRadioMenu.__init__`.

:param str top_separator: See :meth:`PagedRadioMenu.__init__`.

:param str bottom_separator: See :meth:`PagedRadioMenu.__init__`.

:param bool fill: See :meth:`PagedRadioMenu.__init__`.

:param _BaseMenu parent_menu: See :meth:`PagedRadioMenu.__init__`.

:param int items_per_page: Number of options that should be displayed

on a single page.

"""

title, top_separator, bottom_separator, fill, parent_menu, show_pages)

self.items_per_page = items_per_page</div>

def _get_max_item_count(self):

return self.items_per_page</div>

class _BaseRadioOption(_BaseOption):

"""Base class for radio options."""

def _get_highlight_prefix(self):

"""Return the hightlight prefix if ``highlight`` was set.

Else it will return an empty string.

"""

return '->' if self.highlight else ''

class SimpleRadioOption(_BaseRadioOption):

"""Provides options for :class:`SimpleRadioMenu` objects."""

def __init__(

self, choice_index, text, value=None,

highlight=True, selectable=True):

"""Initialize the option.

:param int choice_index: The number that is required to select the

option.

:param str text: See :meth:`menus.base._BaseOption.__init__`.

:param value: See :meth:`menus.base._BaseOption.__init__`.

:param bool hightlight: If True the text will be highlighted.

:param bool selectable: If True the option will be selectable.

"""

super().__init__(text, value, highlight, selectable)

self.choice_index = choice_index</div>

def _render(self, player_index, choice_index=None):

"""See :meth:`menus.base._MenuData._render`."""

return '{0}{1}. {2}\n'.format(

self._get_highlight_prefix(),

self.choice_index,

_translate_text(self.text, player_index)

)</div>

class PagedRadioOption(_BaseRadioOption):

"""Provides options for :class:`PagedRadioMenu` objects."""

"""See :meth:`menus.base._MenuData._render`."""

self._get_highlight_prefix(),

choice_index,

)</div>

class ListRadioOption(PagedRadioOption):

"""Provides options for :class:`ListRadioMenu` objects."""

def __init__(self, text, highlight=True, enumerated=True):

"""Initialize the option.

:param str text: See :meth:`menus.base._BaseOption.__init__`.

:param bool hightlight: If True the text will be highlighted.

:param bool enumerated: If True the number of the option will be added

in front of the text.

.. note:: ``highlight`` only works if ``enumerated`` is set to True.

"""

super().__init__(text, None, highlight, False)

self.enumerated = enumerated</div>

"""See :meth:`menus.base._MenuData._render`."""

if self.enumerated:

return super()._render(player_index, choice_index)

return '{}{}\n'.format(self._get_highlight_prefix(),

</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 v743 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="">menus.radio</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

radio.html

Latest commit

History

radio.html

File metadata and controls